Foxit PDF SDK

Public 类型 | Public 成员函数 | Public 属性 | 所有成员列表
foxit::ofd::AlignmentWatermarkSettings类 参考
类 foxit::ofd::AlignmentWatermarkSettings 继承关系图:

## Public 类型
enum | WatermarkHAlign { e_WatermarkHAlignLeft = 0, e_WatermarkHAlignCenter = 1, e_WatermarkHAlignRight = 2 }
| OFD水印水平对齐方式定义枚举类型. 更多...
enum | WatermarkVAlign { e_WatermarkVAlignTop = 0, e_WatermarkVAlignMiddle = 1, e_WatermarkVAlignBottom = 2 }
| OFD水印垂直对齐方式定义枚举类型. 更多...

## Public 成员函数
| AlignmentWatermarkSettings (WatermarkHAlign h_align, WatermarkVAlign v_align, float width, float height, float rotation, foxit::uint8 opacity, bool visible=true, bool printable=true)
| 带参数的构造函数。 更多...
| AlignmentWatermarkSettings (const AlignmentWatermarkSettings &settings)
| 构造函数，通过另一个水印对齐属性对象。 更多...
virtual bool | IsValid () const
| 检查当前对象是否有效。 更多...
AlignmentWatermarkSettings & | operator= (const AlignmentWatermarkSettings &settings)
| 赋值操作符。 更多...
void | Set (WatermarkHAlign h_align, WatermarkVAlign v_align, float width, float height, float rotation, foxit::uint8 opacity, bool visible=true, bool printable=true)
| 设置值。 更多...
Public 成员函数 继承自 foxit::ofd::BaseWatermarkSettings
| BaseWatermarkSettings (float width, float height, float rotation, foxit::uint8 opacity, bool visible=true, bool printable=true)
| 带参数的构造函数。 更多...
| BaseWatermarkSettings (const BaseWatermarkSettings &settings)
| 构造函数，通过另一个水印基本属性对象。 更多...
BaseWatermarkSettings & | operator= (const BaseWatermarkSettings &settings)
| 赋值操作符。 更多...
void | Set (float width, float height, float rotation, foxit::uint8 opacity, bool visible=true, bool printable=true)
| 设置值。 更多...

## Public 属性
WatermarkHAlign | h_align
| 水印水平对齐方式。请参考从 foxit::ofd::AlignmentWatermarkSettings::e_WatermarkHAlignLeft 开始的值， 这应该是这些值中的一个。 更多...
WatermarkVAlign | v_align
| 水印垂直对齐方式。请参考从 foxit::ofd::AlignmentWatermarkSettings::e_WatermarkVAlignTop 开始的值， 这应该是这些值中的一个。 更多...
Public 属性 继承自 foxit::ofd::BaseWatermarkSettings
float | height
| 水印高度，单位为毫米。 更多...
foxit::uint8 | opacity
| 水印透明度，范围为0-255，0表示完全透明，255表示不透明。 更多...
bool | printable
| 水印是否可打印。 更多...
float | rotation
| 水印顺时针旋转角度，范围为0-360。 更多...
bool | visible
| 水印是否可见。 更多...
float | width
| 水印宽度，单位为毫米。 更多...

## 详细描述

此类表示和OFD水印相关的对齐属性。

## 成员枚举类型说明

## ◆ WatermarkHAlign

enum foxit::ofd::AlignmentWatermarkSettings::WatermarkHAlign

OFD水印水平对齐方式定义枚举类型.

该枚举值应单独使用.

枚举值
e_WatermarkHAlignLeft | 水平对齐方式：左对齐。
e_WatermarkHAlignCenter | 水平对齐方式：居中对齐。
e_WatermarkHAlignRight | 水平对齐方式：右对齐。

## ◆ WatermarkVAlign

enum foxit::ofd::AlignmentWatermarkSettings::WatermarkVAlign

OFD水印垂直对齐方式定义枚举类型.

该枚举值应单独使用.

枚举值
e_WatermarkVAlignTop | 垂直对齐方式：上对齐。
e_WatermarkVAlignMiddle | 垂直对齐方式：居中对齐。
e_WatermarkVAlignBottom | 垂直对齐方式：下对齐。

## 构造及析构函数说明

## ◆ AlignmentWatermarkSettings() [1/2]

foxit::ofd::AlignmentWatermarkSettings::AlignmentWatermarkSettings | ( | WatermarkHAlign | h_align,
|  | WatermarkVAlign | v_align,
|  | float | width,
|  | float | height,
|  | float | rotation,
|  | foxit::uint8 | opacity,
|  | bool | visible = `true`,
|  | bool | printable = `true`
| ) |  |
| inline explicit

带参数的构造函数。

参数

  [in] | h_align | 水印水平对齐方式。请参考从 foxit::ofd::AlignmentWatermarkSettings::e_WatermarkHAlignLeft 开始的值， 这应该是这些值中的一个。
  [in] | v_align | 水印垂直对齐方式。请参考从 foxit::ofd::AlignmentWatermarkSettings::e_WatermarkVAlignTop 开始的值， 这应该是这些值中的一个。
  [in] | width | 水印宽度，单位为毫米。
  [in] | height | 水印高度，单位为毫米。
  [in] | rotation | 水印顺时针旋转角度，范围为0-360。
  [in] | opacity | 水印透明度，范围为0-255，0表示完全透明，255表示不透明。
  [in] | visible | 水印是否可见，默认值为true。
  [in] | printable | 水印是否可打印，默认值为true。

## ◆ AlignmentWatermarkSettings() [2/2]

foxit::ofd::AlignmentWatermarkSettings::AlignmentWatermarkSettings | ( | const AlignmentWatermarkSettings & | settings | ) |
| inline

构造函数，通过另一个水印对齐属性对象。

参数

  [in] | settings | 另一个水印对齐属性对象。

## 成员函数说明

## ◆ IsValid()

virtual bool foxit::ofd::AlignmentWatermarkSettings::IsValid | ( |  | ) | const
| inline virtual

检查当前对象是否有效。

当前对象有效时，表示当前对象包含合法的水印基本属性信息。

返回
  true 表示当前对象有效，false 表示无效。

重载 foxit::ofd::BaseWatermarkSettings .

## ◆ operator=()

AlignmentWatermarkSettings& foxit::ofd::AlignmentWatermarkSettings::operator= | ( | const AlignmentWatermarkSettings & | settings | ) |
| inline

赋值操作符。

参数

  [in] | settings | 另一个水印对齐属性对象，其值将被赋给当前对象。

返回
  当前对象自身的引用。

## ◆ Set()

void foxit::ofd::AlignmentWatermarkSettings::Set | ( | WatermarkHAlign | h_align,
|  | WatermarkVAlign | v_align,
|  | float | width,
|  | float | height,
|  | float | rotation,
|  | foxit::uint8 | opacity,
|  | bool | visible = `true`,
|  | bool | printable = `true`
| ) |  |
| inline

设置值。

参数

  [in] | h_align | 水印水平对齐方式。请参考从 foxit::ofd::AlignmentWatermarkSettings::e_WatermarkHAlignLeft 开始的值， 这应该是这些值中的一个。
  [in] | v_align | 水印垂直对齐方式。请参考从 foxit::ofd::AlignmentWatermarkSettings::e_WatermarkVAlignTop 开始的值， 这应该是这些值中的一个。
  [in] | width | 水印宽度，单位为毫米。
  [in] | height | 水印高度，单位为毫米。
  [in] | rotation | 水印顺时针旋转角度，范围为0-360。
  [in] | opacity | 水印透明度，范围为0-255，0表示完全透明，255表示不透明。
  [in] | visible | 水印是否可见，默认值为true。
  [in] | printable | 水印是否可打印，默认值为true。

返回
  无。

## 类成员变量说明

## ◆ h_align

WatermarkHAlign foxit::ofd::AlignmentWatermarkSettings::h_align

水印水平对齐方式。请参考从 foxit::ofd::AlignmentWatermarkSettings::e_WatermarkHAlignLeft 开始的值， 这应该是这些值中的一个。

## ◆ v_align

WatermarkVAlign foxit::ofd::AlignmentWatermarkSettings::v_align

水印垂直对齐方式。请参考从 foxit::ofd::AlignmentWatermarkSettings::e_WatermarkVAlignTop 开始的值， 这应该是这些值中的一个。