|
Foxit PDF SDK
|
Public 成员函数 | |
| def | GetIconName () |
| 获取图标名称。 更多... | |
| def | GetRotation () |
| 获取当前旋转角度(顺时针方向)。 更多... | |
| def | Rotate (angle) |
| 从当前状态按指定角度度数顺时针旋转当前注释。 更多... | |
| def | SetBitmap (bitmap) |
| 为当前印章注释设置位图。 更多... | |
| def | SetIconName (icon_name) |
| 设置图标名称。 更多... | |
| def | SetImage (image, frame_index, compress) |
| 为当前印章注释设置图像,使用指定的帧索引。 更多... | |
| def | SetRotation (angle) |
| 设置旋转角度(顺时针方向)。 更多... | |
印章注释显示文本或图形,看起来像是用橡皮图章盖在页面上的。
印章注释的外观可以是图标或位图。目前,福昕PDF SDK对预定义的标准印章图标 没有任何默认外观,因此如果印章用图标表示,用户应该通过函数 fsdk.LibrarySetAnnotIconProviderCallback 为福昕PDF SDK 设置自定义注释图标提供器。
印章注释是一种标记注释,所以类Stamp 派生自 类Markup ,并且还提供了获取/设置印章注释属性和 重置印章注释外观流的函数。
在重置印章注释的外观流之前,请确保印章注释已设置有效的位图或图像, 或者它有一个图标名称且福昕PDF SDK已设置了支持的自定义注释图标提供器; 否则印章注释无法重置外观流。
| def fsdk.Stamp.GetIconName | ( | ) |
获取图标名称。
当为Foxit PDF SDK设置了支持的自定义注释图标提供器时,此属性可能对印章注释的外观产生影响。 印章注释具有预定义的标准图标名称:
"Approved"、"AsIs"、"Confidential"、"Departmental"、"Draft"、 "Experimental"、"Expired"、"Final"、"ForComment"、"ForPublicRelease"、 "NotApproved"、"NotForPublicRelease"、"Sold"、"TopSecret"。
| def fsdk.Stamp.GetRotation | ( | ) |
获取当前旋转角度(顺时针方向)。
| def fsdk.Stamp.Rotate | ( | angle | ) |
从当前状态按指定角度度数顺时针旋转当前注释。
| [in] | angle | 角度度数值,用于从当前状态顺时针旋转当前注释。 取值范围:从0到360。特别地,如果输入值为0或360(意味着不旋转当前注释), 当前函数将不执行任何操作。 |
| def fsdk.Stamp.SetBitmap | ( | bitmap | ) |
为当前印章注释设置位图。
如果用户希望新位图对注释的外观产生影响,请在设置新位图后调用函数 fsdk.Annot.ResetAppearanceStream 。
| [in] | bitmap | 要设置给当前印章的位图。 |
| def fsdk.Stamp.SetIconName | ( | icon_name | ) |
设置图标名称。
当为Foxit PDF SDK设置了支持的自定义注释图标提供器时,此属性可能对印章注释的外观产生影响。 印章注释具有预定义的标准图标名称:
"Approved"、"AsIs"、"Confidential"、"Departmental"、"Draft"、 "Experimental"、"Expired"、"Final"、"ForComment"、"ForPublicRelease"、 "NotApproved"、"NotForPublicRelease"、"Sold"、"TopSecret"。
一旦用户为当前印章注释设置了新的图标名称,请确保在调用函数 fsdk.Annot.ResetAppearanceStream (从Stamp的父类继承)之前, 已通过函数fsdk.LibrarySetAnnotIconProviderCallback 为Foxit PDF SDK设置了自定义图标提供器。 对于新创建的印章注释,如果未调用当前函数, 图标名称默认为"Draft"。
如果用户希望新图标名称对注释的外观产生影响,请确保已为Foxit PDF SDK设置了 支持的自定义注释图标提供器,然后在设置新图标名称后调用函数 fsdk.Annot.ResetAppearanceStream 。
| [in] | icon_name | 要设置的新图标名称字符串。空的图标名称字符串意味着当前 印章注释的图标将被视为"Draft"。 |
| def fsdk.Stamp.SetImage | ( | image, | |
| frame_index, | |||
| compress | |||
| ) |
为当前印章注释设置图像,使用指定的帧索引。
输入图像可能包含多个帧,只有图像的一个帧可以设置给当前印章注释。
如果用户希望新图像对注释的外观产生影响,请在设置新图像后调用函数 fsdk.Annot.ResetAppearanceStream 。
| [in] | image | 图像。其中一个帧将被设置给当前印章。 此图像至少包含一个帧,且图像类型不应为 fsdk.ImageE_Unknown 。 |
| [in] | frame_index | 帧索引。有效范围:从0到(count-1)。 count由函数fsdk.Image.GetFrameCount 返回。 |
| [in] | compress | 用于压缩图像数据的压缩算法类型。 目前,它只支持2个有效值:
|
| def fsdk.Stamp.SetRotation | ( | angle | ) |
设置旋转角度(顺时针方向)。
此属性对印章注释的外观有影响。如果用户希望效果显示在注释的外观中, 请在此函数后调用函数fsdk.Annot.ResetAppearanceStream 。
| [in] | angle | 要设置给当前注释的新旋转角度(顺时针方向)。取值范围:从0到360。 |