Foxit PDF SDK
foxit.pdf.FillSign类 参考
类 foxit.pdf.FillSign 继承关系图:
foxit.common.Base

Public 类型

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

Public 成员函数

 FillSign (PDFPage page)
 构造函数,从PDF页面对象构造。 更多...
 
 FillSign (FillSign other)
 构造函数,使用另一个 FillSign 对象。 更多...
 
FillSignObject AddObject (FillSign.FillSignObjectType type, PointF point, float width, float height, Rotation rotation)
 向相关PDF页面(在构造函数中使用的)添加新的填充签名对象(除了文本填充签名对象)。 更多...
 
FillSignObject AddTextObject (TextFillSignObjectDataArray text_data, PointF point, float width, float height, Rotation rotation, bool is_comb_field_mode)
 向相关PDF页面(在构造函数中使用的)添加新的文本填充签名对象。 更多...
 
FillSignObject GetObjectAtDevicePoint (PointF point, Matrix2D matrix)
 通过设备坐标系中的指定点获取填充签名对象。 更多...
 
FillSignObject GetObjectAtPoint (PointF point)
 通过中的指定点获取填充签名对象。 更多...
 
bool IsEmpty ()
 检查当前对象是否为空。 更多...
 
bool RemoveObject (FillSignObject fillsign_object)
 删除指定的填充签名对象。 更多...
 

详细描述

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

成员枚举类型说明

◆ FillSignObjectType

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

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

枚举值
e_FillSignObjectTypeText 

文本填充签名对象。

e_FillSignObjectTypeCrossMark 

叉号标记填充签名对象。

e_FillSignObjectTypeCheckMark 

勾号标记填充签名对象。

e_FillSignObjectTypeRoundRectangle 

圆角矩形填充签名对象。

e_FillSignObjectTypeLine 

线条填充签名对象。

e_FillSignObjectTypeDot 

点填充签名对象。

e_FillSignObjectTypeSignature 

签名填充签名对象。

e_FillSignObjectTypeInitialsSignature 

首字母签名填充签名对象。

构造及析构函数说明

◆ FillSign() [1/2]

foxit.pdf.FillSign.FillSign ( PDFPage  page)
inline

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

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

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

◆ FillSign() [2/2]

foxit.pdf.FillSign.FillSign ( FillSign  other)
inline

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

参数
[in]other另一个对象。

成员函数说明

◆ AddObject()

FillSignObject foxit.pdf.FillSign.AddObject ( FillSign.FillSignObjectType  type,
PointF  point,
float  width,
float  height,
Rotation  rotation 
)
inline

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

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

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

◆ AddTextObject()

FillSignObject foxit.pdf.FillSign.AddTextObject ( TextFillSignObjectDataArray  text_data,
PointF  point,
float  width,
float  height,
Rotation  rotation,
bool  is_comb_field_mode 
)
inline

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

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

  • false表示以普通模式设置输入文本数据。对于每个文本填充签名对象数据, 成员text_statecharspace将不被使用。

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

◆ GetObjectAtDevicePoint()

FillSignObject foxit.pdf.FillSign.GetObjectAtDevicePoint ( PointF  point,
Matrix2D  matrix 
)
inline

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

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

参数
[in]point设备坐标系中的指定点。
[in]matrix从设备坐标系到的变换矩阵。
返回
一个填充签名对象。

◆ GetObjectAtPoint()

FillSignObject foxit.pdf.FillSign.GetObjectAtPoint ( PointF  point)
inline

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

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

参数
[in]point中的指定点。
返回
一个填充签名对象。

◆ IsEmpty()

bool foxit.pdf.FillSign.IsEmpty ( )
inline

检查当前对象是否为空。

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

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

◆ RemoveObject()

bool foxit.pdf.FillSign.RemoveObject ( FillSignObject  fillsign_object)
inline

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

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

参数
[in]fillsign_object要删除的填充签名对象。
返回
true表示成功,false表示失败。