Foxit PDF SDK

Public 类型 | Public 成员函数 | 所有成员列表
foxit::pdf::FillSign类 参考
类 foxit::pdf::FillSign 继承关系图:

## Public 类型
enum | FillSignObjectType { e_FillSignObjectTypeText = 0, e_FillSignObjectTypeCrossMark = 1, e_FillSignObjectTypeCheckMark = 2, e_FillSignObjectTypeRoundRectangle = 3, e_FillSignObjectTypeLine = 4, e_FillSignObjectTypeDot = 5, e_FillSignObjectTypeSignature = 6, e_FillSignObjectTypeInitialsSignature = 7 }
| 填充签名对象类型的枚举。 更多...

## Public 成员函数
| FillSign (const PDFPage &page)
| 构造函数，从PDF页面对象构造。 更多...
| FillSign (const FillSign &other)
| 构造函数，使用另一个 FillSign 对象。 更多...
| ~FillSign ()
| 析构函数。
FillSignObject | AddObject (FillSignObjectType type, const PointF &point, float width, float height, common::Rotation rotation=common::e_Rotation0)
| 向相关PDF页面（在构造函数中使用的）添加新的填充签名对象（除了文本填充签名对象）。 更多...
FillSignObject | AddTextObject (const TextFillSignObjectDataArray &text_data, const PointF &point, float width, float height, common::Rotation rotation=common::e_Rotation0, bool is_comb_field_mode=false)
| 向相关PDF页面（在构造函数中使用的）添加新的文本填充签名对象。 更多...
FillSignObject | GetObjectAtDevicePoint (const PointF &point, const Matrix &matrix)
| 通过设备坐标系中的指定点获取填充签名对象。 更多...
FillSignObject | GetObjectAtPoint (const PointF &point)
| 通过PDF坐标系中的指定点获取填充签名对象。 更多...
bool | IsEmpty () const
| 检查当前对象是否为空。 更多...
bool | operator != (const FillSign &other) const
| 不相等操作符。 更多...
FillSign & | operator= (const FillSign &other)
| 赋值操作符。 更多...
bool | operator== (const FillSign &other) const
| 相等操作符。 更多...
bool | RemoveObject (const FillSignObject &fillsign_object)
| 删除指定的填充签名对象。 更多...
Public 成员函数 继承自 foxit::Base
FS_HANDLE | Handle () const
| 获取当前对象的句柄。 更多...

## 详细描述

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

## 成员枚举类型说明

## ◆ FillSignObjectType

enum foxit::pdf::FillSign::FillSignObjectType

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

此枚举的值可以单独使用。

枚举值
e_FillSignObjectTypeText | 文本填充签名对象。
e_FillSignObjectTypeCrossMark | 叉号标记填充签名对象。
e_FillSignObjectTypeCheckMark | 勾号标记填充签名对象。
e_FillSignObjectTypeRoundRectangle | 圆角矩形填充签名对象。
e_FillSignObjectTypeLine | 线条填充签名对象。
e_FillSignObjectTypeDot | 点填充签名对象。
e_FillSignObjectTypeSignature | 签名填充签名对象。
e_FillSignObjectTypeInitialsSignature | 首字母签名填充签名对象。

## 构造及析构函数说明

## ◆ FillSign() [1/2]

foxit::pdf::FillSign::FillSign | ( | const PDFPage & | page | ) |
| explicit

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

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

参数

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

## ◆ FillSign() [2/2]

foxit::pdf::FillSign::FillSign | ( | const FillSign & | other | ) |

构造函数，使用另一个 FillSign 对象。

参数

  [in] | other | 另一个对象。

## 成员函数说明

## ◆ AddObject()

FillSignObject foxit::pdf::FillSign::AddObject | ( | FillSignObjectType | type,
|  | const PointF & | point,
|  | float | width,
|  | float | height,
|  | common::Rotation | rotation = `common::e_Rotation0`
| ) |  |

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

此函数可用于添加除类型 FillSign::e_FillSignObjectTypeText 之外的填充签名对象。 如果您想添加类型为 FillSign::e_FillSignObjectTypeText 的填充签名对象， 请调用函数 FillSign::AddTextObject。

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

参数

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

返回
  一个新的填充签名对象。

## ◆ AddTextObject()

FillSignObject foxit::pdf::FillSign::AddTextObject | ( | const TextFillSignObjectDataArray & | text_data,
|  | const PointF & | point,
|  | float | width,
|  | float | height,
|  | common::Rotation | rotation = `common::e_Rotation0`,
|  | bool | is_comb_field_mode = `false`
| ) |  |

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

参数

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

返回
  一个新的填充签名对象。

## ◆ GetObjectAtDevicePoint()

FillSignObject foxit::pdf::FillSign::GetObjectAtDevicePoint | ( | const PointF & | point,
|  | const Matrix & | matrix
| ) |  |

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

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

参数

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

返回
  一个填充签名对象。

## ◆ GetObjectAtPoint()

FillSignObject foxit::pdf::FillSign::GetObjectAtPoint | ( | const PointF & | point | ) |

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

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

参数

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

返回
  一个填充签名对象。

## ◆ IsEmpty()

bool foxit::pdf::FillSign::IsEmpty | ( |  | ) | const

检查当前对象是否为空。

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

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

## ◆ operator !=()

bool foxit::pdf::FillSign::operator != | ( | const FillSign & | other | ) | const

不相等操作符。

参数

  [in] | other | 另一个 FillSign 对象。此函数将检查当前对象是否不等于这个对象。

返回
  true表示不相等，false表示相等。

## ◆ operator=()

FillSign& foxit::pdf::FillSign::operator= | ( | const FillSign & | other | ) |

赋值操作符。

参数

  [in] | other | 另一个 FillSign 对象，其值将被赋值给当前对象。

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

## ◆ operator==()

bool foxit::pdf::FillSign::operator== | ( | const FillSign & | other | ) | const

相等操作符。

参数

  [in] | other | 另一个 FillSign 对象。此函数将检查当前对象是否等于这个对象。

返回
  true表示相等，false表示不相等。

## ◆ RemoveObject()

bool foxit::pdf::FillSign::RemoveObject | ( | const FillSignObject & | fillsign_object | ) |

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

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

参数

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

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