Foxit PDF SDK

Public 类型 | Public 成员函数 | Public 属性 | 所有成员列表
foxit::pdf::WatermarkTextProperties类 参考

继承自 Object .

## Public 类型
enum | FontStyle { e_FontStyleNormal = 0, e_FontStyleUnderline = 1 }
| 水印字体样式的枚举。 更多...

## Public 成员函数
| WatermarkTextProperties ()
| 构造函数。
| WatermarkTextProperties (const common::Font &font, float font_size, RGB color, FontStyle style, float line_space, foxit::common ::Alignment alignment)
| 带参数的构造函数。 更多...
| WatermarkTextProperties (const WatermarkTextProperties &properties)
| 带另一个水印文本属性对象的构造函数。 更多...
WatermarkTextProperties & | operator= (const WatermarkTextProperties &properties)
| 赋值操作符。 更多...
void | Set (const common::Font &font, float font_size, RGB color, FontStyle style, float line_space, foxit::common ::Alignment alignment)
| 设置值。 更多...

## Public 属性
foxit::common ::Alignment | alignment
| 文本水平对齐方式。默认值为common::e_AlignmentLeft。 更多...
RGB | color
| 文本颜色。格式：0xRRGGBB。默认值为0x000000。
common::Font | font
| 用于文本的字体对象。
float | font_size
| 字体大小，以点为单位。默认值为24.0。
FontStyle | font_style
| 字体样式。默认值为WatermarkTextProperties::e_FontStyleNormal。 更多...
float | line_space
| 行间距，以行高为单位。默认值为1.0。 更多...

## 详细描述

此类表示用于从文本构造水印对象的水印文本设置。

## 成员枚举类型说明

## ◆ FontStyle

enum foxit::pdf::WatermarkTextProperties::FontStyle

水印字体样式的枚举。

此枚举的值应单独使用。

枚举值
e_FontStyleNormal | 水印字体样式：正常。
e_FontStyleUnderline | 水印字体样式：带下划线。

## 构造及析构函数说明

## ◆ WatermarkTextProperties() [1/2]

foxit::pdf::WatermarkTextProperties::WatermarkTextProperties | ( | const common::Font & | font,
|  | float | font_size,
|  | RGB | color,
|  | FontStyle | style,
|  | float | line_space,
|  | foxit::common ::Alignment | alignment
| ) |  |
| inline

带参数的构造函数。

参数line_space和alignment不支持平铺水印，设置后将无效果。

参数

  [in] | font | 用于文本的有效字体对象。
  [in] | font_size | 字体大小，以点为单位。
  [in] | color | 文本颜色。格式：0xRRGGBB。
  [in] | style | 字体样式。应为以下值之一： WatermarkTextProperties::e_FontStyleNormal WatermarkTextProperties::e_FontStyleUnderline
  [in] | line_space | 行间距，以行高为单位。此值指定行间距的行高倍数。 有效范围：从0到10（不包括0但包括10）。如果此值大于10， 将使用10作为文本水印的默认值。
  [in] | alignment | 文本水平对齐方式。应为以下值之一： common::e_AlignmentLeft common::e_AlignmentCenter common::e_AlignmentRight

## ◆ WatermarkTextProperties() [2/2]

foxit::pdf::WatermarkTextProperties::WatermarkTextProperties | ( | const WatermarkTextProperties & | properties | ) |
| inline

带另一个水印文本属性对象的构造函数。

参数

  [in] | properties | 另一个水印文本属性对象。

## 成员函数说明

## ◆ operator=()

WatermarkTextProperties& foxit::pdf::WatermarkTextProperties::operator= | ( | const WatermarkTextProperties & | properties | ) |
| inline

赋值操作符。

参数

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

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

## ◆ Set()

void foxit::pdf::WatermarkTextProperties::Set | ( | const common::Font & | font,
|  | float | font_size,
|  | RGB | color,
|  | FontStyle | style,
|  | float | line_space,
|  | foxit::common ::Alignment | alignment
| ) |  |
| inline

设置值。

参数line_space和alignment不支持平铺水印，设置后将无效果。

参数

  [in] | font | 用于文本的有效字体对象。
  [in] | font_size | 字体大小，以点为单位。
  [in] | color | 文本颜色。格式：0xRRGGBB。
  [in] | style | 字体样式。应为以下值之一： WatermarkTextProperties::e_FontStyleNormal WatermarkTextProperties::e_FontStyleUnderline
  [in] | line_space | 行间距，以行高为单位。此值指定行间距的行高倍数。 有效范围：从0到10（不包括0但包括10）。如果此值大于10， 将使用10作为文本水印的默认值。
  [in] | alignment | 文本水平对齐方式。应为以下值之一： common::e_AlignmentLeft common::e_AlignmentCenter common::e_AlignmentRight

返回
  无。

## 类成员变量说明

## ◆ alignment

foxit::common ::Alignment foxit::pdf::WatermarkTextProperties::alignment

文本水平对齐方式。默认值为common::e_AlignmentLeft。

应为以下宏定义之一：

- common::e_AlignmentLeft
- common::e_AlignmentCenter
- common::e_AlignmentRight

## ◆ font_style

FontStyle foxit::pdf::WatermarkTextProperties::font_style

字体样式。默认值为WatermarkTextProperties::e_FontStyleNormal。

应为以下值之一：

- WatermarkTextProperties::e_FontStyleNormal
- WatermarkTextProperties::e_FontStyleUnderline

## ◆ line_space

float foxit::pdf::WatermarkTextProperties::line_space

行间距，以行高为单位。默认值为1.0。

此值用于指定行间距的行高倍数。 有效范围：从0到10（不包括0但包括10）。如果此值大于10，将使用10 作为文本水印的默认值。