Foxit PDF SDK
FSStamp类 参考
类 FSStamp 继承关系图:
FSMarkup FSAnnot FSBase

构造函数

(id) - init
 构造函数。

 
(id) - initWithAnnot:
 构造函数,使用父类对象。
更多...
 
(void) - rotate:
 从当前状态按指定角度度数顺时针旋转当前注释。
更多...
 
(void) - setBitmap:
 为当前印章注释设置位图。
更多...
 
(void) - setImage:frame_index:compress:
 为当前印章注释设置图像,使用指定的帧索引。
更多...
 
- 构造函数 继承自 FSMarkup
(FSNote *) - addReply
 在回复列表的末尾添加新回复。
更多...
 
(void) - addRichText:style:
 在末尾添加新的富文本字符串。
更多...
 
(FSNote *) - addStateAnnot:model:state:
 添加新的状态注释。
更多...
 
(FSMarkupArray *) - getGroupElements
 从当前标记注释所属的组中获取一个元素(作为标记注释)。
更多...
 
(FSMarkup *) - getGroupHeader
 获取当前标记注释所属组的头注释(作为主注释)。
更多...
 
(FSNote *) - getReply:
 按索引获取回复。
更多...
 
(int) - getReplyCount
 计算所有回复。
更多...
 
(NSString *) - getRichTextContent:
 获取指定索引的富文本字符串的文本字符串。
更多...
 
(int) - getRichTextCount
 获取富文本字符串的数量。
更多...
 
(FSRichTextStyle *) - getRichTextStyle:
 获取指定索引的富文本字符串的样式数据。
更多...
 
(FSNoteArray *) - getStateAnnots:
 获取指定状态模型中的所有状态注释。
更多...
 
(void) - insertRichText:content:style:
 在指定索引位置插入新的富文本字符串。
更多...
 
(BOOL) - isGrouped
 检查当前标记注释是否在组中。
更多...
 
(BOOL) - removeAllReplies
 删除所有回复。
更多...
 
(BOOL) - removeAllStateAnnots
 移除所有状态注释。
更多...
 
(BOOL) - removePopup
 删除相关的弹出注释。
更多...
 
(BOOL) - removeReply:
 按索引删除回复。
更多...
 
(void) - removeRichText:
 移除指定索引的富文本字符串。
更多...
 
(void) - setRichTextContent:content:
 设置指定索引的富文本字符串的文本字符串。
更多...
 
(void) - setRichTextStyle:style:
 设置指定索引的富文本字符串的样式数据。
更多...
 
(BOOL) - ungroup
 将当前标记注释从其所属的组中解组。
更多...
 
- 构造函数 继承自 FSAnnot
(BOOL) - FSMoveWithResetAppearance:is_reset_appearance:
 将当前注释移动到新位置,由中的新矩形指定。
更多...
 
(BOOL) - FSResetApStreamWithIsGenerateNewAppearanceObj:
 重置外观流。
更多...
 
(FSPDFStream *) - getAppearanceStream:appearance_state:
 获取具有指定类型和状态的注释外观流。
更多...
 
(FSRectI *) - getDeviceRect:
 获取设备坐标系统中的注释矩形。
更多...
 
(FSPDFDictionary *) - getDict
 获取注释的字典对象。
更多...
 
(FSMatrix2D *) - getDisplayMatrix:
 获取显示矩阵,从到 目标设备坐标系统。
更多...
 
(int) - getIndex
 获取当前注释在其所属页面中的索引。
更多...
 
(FSPDFDictionary *) - getOptionalContent
 获取注释可选内容的PDF字典。
更多...
 
(FSPDFPage *) - getPage
 获取相关的PDF页面。
更多...
 
(FSRectF *) - getRect
 获取矩形,以表示。
更多...
 
(FSAnnotType- getType
 获取当前注释的实际注释类型。
更多...
 
(BOOL) - hasProperty:
 当前注释是否具有指定的注释属性。
更多...
 
(id) - initWithPage:annot_dict:
 构造函数,使用PDF页面和注释的PDF字典。
更多...
 
(BOOL) - isEmpty
 检查当前对象是否为空。
更多...
 
(BOOL) - isMarkup
 检查当前注释是否为标记注释。
更多...
 
(BOOL) - move:
 将当前注释移动到新位置,由中的新矩形指定。
更多...
 
(BOOL) - removeProperty:
 删除指定的注释属性。
更多...
 
(BOOL) - resetAppearanceStream
 重置外观流。
更多...
 

属性

NSString * iconName
 获取图标名称。
更多...
 
int rotation
 获取当前旋转角度(顺时针方向)。

 
- 属性 继承自 FSMarkup
float borderOpacity
 获取注释的边框透明度。

 
FSDateTime * creationDateTime
 获取创建日期时间。

 
float fillOpacity
 获取注释的填充透明度。

 
NSString * intent
 获取意图名称。
更多...
 
float opacity
 获取不透明度值。
更多...
 
FSPopuppopup
 获取相关的弹出注释。
更多...
 
NSString * subject
 获取主题字符串。

 
NSString * title
 获取标题字符串。
更多...
 
- 属性 继承自 FSAnnot
unsigned int borderColor
 获取边框颜色。
更多...
 
FSBorderInfoborderInfo
 获取边框信息。
更多...
 
NSString * content
 获取内容。

 
unsigned int flags
 获取注释标志。

 
FSDateTime * modifiedDateTime
 获取最后修改日期时间。

 
NSString * uniqueID
 获取唯一ID。

 

详细描述

印章注释显示文本或图形,看起来像是用橡皮图章盖在页面上的。
印章注释的外观可以是图标或位图。目前,福昕PDF SDK对预定义的标准印章图标 没有任何默认外观,因此如果印章用图标表示,用户应该通过函数 FSLibrary::setAnnotIconProviderCallback:为福昕PDF SDK 设置自定义注释图标提供器。
印章注释是一种标记注释,所以类FSStamp 派生自 类FSMarkup ,并且还提供了获取/设置印章注释属性和 重置印章注释外观流的函数。
在重置印章注释的外观流之前,请确保印章注释已设置有效的位图或图像, 或者它有一个图标名称且福昕PDF SDK已设置了支持的自定义注释图标提供器; 否则印章注释无法重置外观流。

注解
对于新创建的印章注释,某些属性将设置为默认值:
不透明度 = 1.0,图标名称 = "Draft"。
在调用FSAnnot::resetAppearanceStream(从FSStamp 的父类继承)之前, 用户应确保通过函数FSStamp::setBitmap:FSStamp::setImage:frame_index:compress:为印章设置位图,或通过函数 FSLibrary::setAnnotIconProviderCallback:为福昕PDF SDK 设置有用的自定义注释图标提供器。
参见
FSMarkup
FSLibrary

函数文档

◆ initWithAnnot:()

- (id) initWithAnnot: (FSAnnot*)  annot

构造函数,使用父类对象。

参数
[in]annot父类对象。

重载 FSMarkup .

◆ rotate:()

- (void) rotate: (int)  angle

从当前状态按指定角度度数顺时针旋转当前注释。

参数
[in]angle角度度数值,用于从当前状态顺时针旋转当前注释。 取值范围:从0到360。特别地,如果输入值为0或360(意味着不旋转当前注释), 当前函数将不执行任何操作。
返回
无。

◆ setBitmap:()

- (void) setBitmap: (FSBitmap*)  bitmap

为当前印章注释设置位图。

如果用户希望新位图对注释的外观产生影响,请在设置新位图后调用函数 FSAnnot::resetAppearanceStream

参数
[in]bitmap要设置给当前印章的位图。
返回
无。

◆ setImage:frame_index:compress:()

- (void) setImage: (FSImage*)  image
frame_index: (int)  frame_index
compress: (int)  compress 

为当前印章注释设置图像,使用指定的帧索引。

输入图像可能包含多个帧,只有图像的一个帧可以设置给当前印章注释。
如果用户希望新图像对注释的外观产生影响,请在设置新图像后调用函数 FSAnnot::resetAppearanceStream

参数
[in]image图像。其中一个帧将被设置给当前印章。 此图像至少包含一个帧,且图像类型不应为 FSImageUnknown
[in]frame_index帧索引。有效范围:从0到(count-1)。 count由函数FSImage::getFrameCount返回。
[in]compress用于压缩图像数据的压缩算法类型。 目前,它只支持2个有效值:
  • 0:不压缩。
  • 1:执行默认压缩。

返回
无。

属性说明

◆ iconName

- (NSString *) iconName
readwritenonatomicweak

获取图标名称。

当为Foxit PDF SDK设置了支持的自定义注释图标提供器时,此属性可能对印章注释的外观产生影响。 印章注释具有预定义的标准图标名称:
"Approved"、"AsIs"、"Confidential"、"Departmental"、"Draft"、 "Experimental"、"Expired"、"Final"、"ForComment"、"ForPublicRelease"、 "NotApproved"、"NotForPublicRelease"、"Sold"、"TopSecret"。