Foxit PDF SDK

Public 成员函数 | 静态 Public 属性 | 所有成员列表
com.foxit.sdk.pdf.WatermarkTextProperties类 参考

## Public 成员函数
| WatermarkTextProperties (Font font, float font_size, long color, int style, float line_space, int alignment)
| 带参数的构造函数。 更多...
| WatermarkTextProperties ()
| 构造函数。
| WatermarkTextProperties (WatermarkTextProperties properties)
| 带另一个水印文本属性对象的构造函数。 更多...
synchronized void | delete ()
| 直接清除C++相关资源。 更多...
int | getAlignment ()
| Get 文本水平对齐方式。默认值为com.foxit.sdk.common.Constants.e_AlignmentLeft 。 更多...
long | getColor ()
| Get 文本颜色。格式：0xRRGGBB。默认值为0x000000。 更多...
Font | getFont ()
| Get 用于文本的字体对象。 更多...
float | getFont_size ()
| Get 字体大小，以点为单位。默认值为24. 更多...
int | getFont_style ()
| Get 字体样式。默认值为com.foxit.sdk.pdf.WatermarkTextProperties.e_FontStyleNormal 。 更多...
float | getLine_space ()
| Get 行间距，以行高为单位。默认值为1. 更多...
void | set (Font font, float font_size, long color, int style, float line_space, int alignment)
| 设置值。 更多...
void | setAlignment (int value)
| Set 文本水平对齐方式。默认值为com.foxit.sdk.common.Constants.e_AlignmentLeft 。 更多...
void | setColor (long value)
| Set 文本颜色。格式：0xRRGGBB。默认值为0x000000。 更多...
void | setFont (Font value)
| Set 用于文本的字体对象。 更多...
void | setFont_size (float value)
| Set 字体大小，以点为单位。默认值为24. 更多...
void | setFont_style (int value)
| Set 字体样式。默认值为com.foxit.sdk.pdf.WatermarkTextProperties.e_FontStyleNormal 。 更多...
void | setLine_space (float value)
| Set 行间距，以行高为单位。默认值为1. 更多...

## 静态 Public 属性
static final int | e_FontStyleNormal = 0
| 水印字体样式：正常。
static final int | e_FontStyleUnderline = 1
| 水印字体样式：带下划线。

## 详细描述

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

## 构造及析构函数说明

## ◆ WatermarkTextProperties() [1/2]

com.foxit.sdk.pdf.WatermarkTextProperties.WatermarkTextProperties | ( | Font | font,
|  | float | font_size,
|  | long | color,
|  | int | style,
|  | float | line_space,
|  | int | alignment
| ) |  |

带参数的构造函数。

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

参数

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

## ◆ WatermarkTextProperties() [2/2]

com.foxit.sdk.pdf.WatermarkTextProperties.WatermarkTextProperties | ( | WatermarkTextProperties | properties | ) |

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

参数

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

## 成员函数说明

## ◆ delete()

synchronized void com.foxit.sdk.pdf.WatermarkTextProperties.delete | ( |  | ) |

直接清除C++相关资源。

返回
  无。

注解
  一旦这个接口被调用，这个对象将不能再被使用。

## ◆ getAlignment()

com.foxit.sdk.pdf.WatermarkTextProperties.getAlignment | ( |  | ) |

Get 文本水平对齐方式。默认值为com.foxit.sdk.common.Constants.e_AlignmentLeft 。

应为以下宏定义之一：

- com.foxit.sdk.common.Constants.e_AlignmentLeft

- com.foxit.sdk.common.Constants.e_AlignmentCenter

- com.foxit.sdk.common.Constants.e_AlignmentRight

返回
  文本水平对齐方式。默认值为com.foxit.sdk.common.Constants.e_AlignmentLeft 。

## ◆ getColor()

com.foxit.sdk.pdf.WatermarkTextProperties.getColor | ( |  | ) |

Get 文本颜色。格式：0xRRGGBB。默认值为0x000000。

返回
  文本颜色。格式：0xRRGGBB。默认值为0x000000。

## ◆ getFont()

com.foxit.sdk.pdf.WatermarkTextProperties.getFont | ( |  | ) |

Get 用于文本的字体对象。

返回
  用于文本的字体对象。

## ◆ getFont_size()

com.foxit.sdk.pdf.WatermarkTextProperties.getFont_size | ( |  | ) |

Get 字体大小，以点为单位。默认值为24.

返回
  字体大小，以点为单位。默认值为24.0。

## ◆ getFont_style()

com.foxit.sdk.pdf.WatermarkTextProperties.getFont_style | ( |  | ) |

Get 字体样式。默认值为com.foxit.sdk.pdf.WatermarkTextProperties.e_FontStyleNormal 。

应为以下值之一：

- com.foxit.sdk.pdf.WatermarkTextProperties.e_FontStyleNormal

- com.foxit.sdk.pdf.WatermarkTextProperties.e_FontStyleUnderline

返回
  字体样式。默认值为com.foxit.sdk.pdf.WatermarkTextProperties.e_FontStyleNormal 。

## ◆ getLine_space()

com.foxit.sdk.pdf.WatermarkTextProperties.getLine_space | ( |  | ) |

Get 行间距，以行高为单位。默认值为1.

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

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

## ◆ set()

void com.foxit.sdk.pdf.WatermarkTextProperties.set | ( | Font | font,
|  | float | font_size,
|  | long | color,
|  | int | style,
|  | float | line_space,
|  | int | alignment
| ) |  |

设置值。

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

参数

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

返回
  无。

## ◆ setAlignment()

com.foxit.sdk.pdf.WatermarkTextProperties.setAlignment | ( | int | value | ) |

Set 文本水平对齐方式。默认值为com.foxit.sdk.common.Constants.e_AlignmentLeft 。

应为以下宏定义之一：

- com.foxit.sdk.common.Constants.e_AlignmentLeft

- com.foxit.sdk.common.Constants.e_AlignmentCenter

- com.foxit.sdk.common.Constants.e_AlignmentRight

参数

  [in] | value | 文本水平对齐方式。默认值为com.foxit.sdk.common.Constants.e_AlignmentLeft 。

返回
  None.

## ◆ setColor()

com.foxit.sdk.pdf.WatermarkTextProperties.setColor | ( | long | value | ) |

Set 文本颜色。格式：0xRRGGBB。默认值为0x000000。

参数

  [in] | value | 文本颜色。格式：0xRRGGBB。默认值为0x000000。

返回
  None.

## ◆ setFont()

com.foxit.sdk.pdf.WatermarkTextProperties.setFont | ( | Font | value | ) |

Set 用于文本的字体对象。

参数

  [in] | value | 用于文本的字体对象。

返回
  None.

## ◆ setFont_size()

com.foxit.sdk.pdf.WatermarkTextProperties.setFont_size | ( | float | value | ) |

Set 字体大小，以点为单位。默认值为24.

参数

  [in] | value | 字体大小，以点为单位。默认值为24.0。

返回
  None.

## ◆ setFont_style()

com.foxit.sdk.pdf.WatermarkTextProperties.setFont_style | ( | int | value | ) |

Set 字体样式。默认值为com.foxit.sdk.pdf.WatermarkTextProperties.e_FontStyleNormal 。

应为以下值之一：

- com.foxit.sdk.pdf.WatermarkTextProperties.e_FontStyleNormal

- com.foxit.sdk.pdf.WatermarkTextProperties.e_FontStyleUnderline

参数

  [in] | value | 字体样式。默认值为com.foxit.sdk.pdf.WatermarkTextProperties.e_FontStyleNormal 。

返回
  None.

## ◆ setLine_space()

com.foxit.sdk.pdf.WatermarkTextProperties.setLine_space | ( | float | value | ) |

Set 行间距，以行高为单位。默认值为1.

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

参数

  [in] | value | 行间距，以行高为单位。默认值为1.0。

返回
  None.