Foxit PDF SDK

Public 成员函数 | 静态 Public 属性 | 所有成员列表
FSDK::FillSign类 参考

## Public 成员函数
| AddObject (type, point, width, height, rotation)
| 向相关PDF页面（在构造函数中使用）添加新的填充签名对象（文本填充签名对象除外）。 更多...
| AddTextObject (text_data, point, width, height, rotation, is_comb_field_mode)
| 向相关PDF页面（在构造函数中使用）添加新的文本填充签名对象。 更多...
| constructor (page)
| 从PDF页面对象构造的构造函数。 更多...
| GetObjectAtDevicePoint (point, matrix)
| 通过设备坐标系中的指定点获取填充签名对象。 更多...
| GetObjectAtPoint (point)
| 通过 PDF坐标系 中的指定点获取填充签名对象。 更多...
| IsEmpty ()
| 检查当前对象是否为空。 更多...
| RemoveObject (fillsign_object)
| 删除指定的填充签名对象。 更多...

## 静态 Public 属性
static | e_FillSignObjectTypeCheckMark
| 勾号标记填充签名对象。
static | e_FillSignObjectTypeCrossMark
| 叉号标记填充签名对象。
static | e_FillSignObjectTypeDot
| 圆点填充签名对象。
static | e_FillSignObjectTypeInitialsSignature
| 首字母签名填充签名对象。
static | e_FillSignObjectTypeLine
| 直线填充签名对象。
static | e_FillSignObjectTypeRoundRectangle
| 圆角矩形填充签名对象。
static | e_FillSignObjectTypeSignature
| 签名填充签名对象。
static | e_FillSignObjectTypeText
| 填充签名对象类型的枚举。 更多...

## 详细描述

填充签名是指将一些图形对象填充到PDF页面并对其进行签名。此类用作填充签名对象的管理器。 用户可以使用此类向PDF页面添加/获取/删除填充签名对象（包括叉号标记、勾号标记、圆点、直线、圆角矩形、 签名和首字母签名）。

## 成员函数说明

## ◆ AddObject()

FSDK::FillSign::AddObject | ( | type | ,
|  | point | ,
|  | width | ,
|  | height | ,
|  | rotation |
| ) |  |

向相关PDF页面（在构造函数中使用）添加新的填充签名对象（文本填充签名对象除外）。

此函数可用于添加除类型 FSDK.FillSign.e_FillSignObjectTypeText 以外的填充签名对象。 如果要添加类型为 FSDK.FillSign.e_FillSignObjectTypeText 的填充签名对象， 请改为调用函数 FSDK.FillSign.AddTextObject。

- 如果要添加类型为 FSDK.FillSign.e_FillSignObjectTypeCrossMark、 FSDK.FillSign.e_FillSignObjectTypeCheckMark、FSDK.FillSign.e_FillSignObjectTypeLine 或 FSDK.FillSign.e_FillSignObjectTypeDot 的填充签名对象，输入宽度和高度中较大的值将 用作新填充签名对象的宽度和高度。
- 如果要添加类型为 FSDK.FillSign.e_FillSignObjectTypeLine 的填充签名对象，输入的 height 无用 且将被忽略。

参数

  [in] | type | 填充签名类型，用于指定要添加的填充签名对象的类型。 请参考从 FSDK.FillSign.e_FillSignObjectTypeCrossMark 开始的值， 应为这些值之一。
  [in] | point | 新填充签名对象的左下角点，使用 PDF坐标系。
  [in] | width | 新填充签名对象的宽度。
  [in] | height | 新填充签名对象的高度。
  [in] | rotation | 旋转状态信息。此旋转值包括视图旋转和页面旋转属性信息。 请参考从 FSDK.e_Rotation0 开始的值， 应为这些值之一，除了 FSDK.e_RotationUnknown。

返回
  新的填充签名对象。

## ◆ AddTextObject()

FSDK::FillSign::AddTextObject | ( | text_data | ,
|  | point | ,
|  | width | ,
|  | height | ,
|  | rotation | ,
|  | is_comb_field_mode |
| ) |  |

向相关PDF页面（在构造函数中使用）添加新的文本填充签名对象。

参数

  [in] | text_data | 要设置到新文本填充签名对象的文本数据数组。对于每个文本填充签名对象数据， 成员 text_state 的 origin_position 将不被使用。
  [in] | point | 新填充签名对象的左下角点，使用 PDF坐标系。
  [in] | width | 新填充签名对象的宽度。
  [in] | height | 新填充签名对象的高度。
  [in] | rotation | 旋转状态信息。此旋转值包括视图旋转和页面旋转属性信息。 请参考从 FSDK.e_Rotation0 开始的值， 应为这些值之一，除了 FSDK.e_RotationUnknown。
  [in] | is_comb_field_mode | 决定是组合字段模式还是普通模式的布尔值： true 表示在组合字段模式下设置输入文本数据。对于每个文本填充签名对象数据， 如果成员 text_state 的 charspace 为0，将改用默认值6.0f。 false 表示在普通模式下设置输入文本数据。对于每个文本填充签名对象数据， 成员 text_state 的 charspace 将不被使用。

返回
  新的填充签名对象。

## ◆ constructor()

FSDK::FillSign::constructor | ( | page |  | ) |

从PDF页面对象构造的构造函数。

请确保输入的PDF页面已成功解析。

参数

  [in] | page | 有效的PDF页面对象。

## ◆ GetObjectAtDevicePoint()

FSDK::FillSign::GetObjectAtDevicePoint | ( | point | ,
|  | matrix |
| ) |  |

通过设备坐标系中的指定点获取填充签名对象。

添加类型为 FSDK.FillSign.e_FillSignObjectTypeSignature 或 FSDK.FillSign.e_FillSignObjectTypeInitialsSignature 的填充签名对象后， 属于同一PDF文档的所有现有填充签名对象都无法检索。

参数

  [in] | point | 设备坐标系中的指定点。
  [in] | matrix | 从设备坐标系到 PDF坐标系 的变换矩阵。

返回
  填充签名对象。

## ◆ GetObjectAtPoint()

FSDK::FillSign::GetObjectAtPoint | ( | point |  | ) |

通过 PDF坐标系 中的指定点获取填充签名对象。

添加类型为 FSDK.FillSign.e_FillSignObjectTypeSignature 或 FSDK.FillSign.e_FillSignObjectTypeInitialsSignature 的填充签名对象后， 属于同一PDF文档的所有现有填充签名对象都无法检索。

参数

  [in] | point | PDF坐标系 中的指定点。

返回
  填充签名对象。

## ◆ IsEmpty()

FSDK::FillSign::IsEmpty | ( |  | ) |

检查当前对象是否为空。

当当前对象为空时，意味着当前对象无用。

返回
  true 表示当前对象为空，而 false 表示不为空。

## ◆ RemoveObject()

FSDK::FillSign::RemoveObject | ( | fillsign_object |  | ) |

删除指定的填充签名对象。

添加类型为 FSDK.FillSign.e_FillSignObjectTypeSignature 或 FSDK.FillSign.e_FillSignObjectTypeInitialsSignature 的填充签名对象后， 属于同一PDF文档的所有现有填充签名对象都无法删除。对于这种情况，如果要删除 任何现有的填充签名对象，此函数将返回 false。

参数

  [in] | fillsign_object | 要删除的填充签名对象。

返回
  true 表示成功，而 false 表示失败。

## 类成员变量说明

## ◆ e_FillSignObjectTypeText

FSDK::FillSign::e_FillSignObjectTypeText
| static

填充签名对象类型的枚举。

此枚举的值应单独使用。

文本填充签名对象。