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

构造函数

(FSMarkup *) - getReplyTo
 获取当前注记注释回复的标记注释。
更多...
 
(FSMarkupStateModel) - getStateModel
 获取状态模型。
更多...
 
(id) - init
 构造函数。

 
(id) - initWithAnnot:
 构造函数,使用父类对象。
更多...
 
(BOOL) - isStateAnnot
 检查当前注记注释是否用作状态注释。
更多...
 
- 构造函数 继承自 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
 获取图标名称。
更多...
 
BOOL openStatus
 获取开放状态。
更多...
 
FSMarkupState state
 获取状态。
更多...
 
- 属性 继承自 FSMarkup
float borderOpacity
 获取注释的边框透明度。

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

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

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

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

 
unsigned int flags
 获取注释标志。

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

 
NSString * uniqueID
 获取唯一ID。

 

详细描述

注记注释(在<PDF参考1.7>中称为"文本"注释)表示附加到PDF文档中某个点的"便签"。 当关闭时,注释显示为图标;当打开时,它显示一个弹出窗口,其中包含由查看器应用程序选择的字体和大小的注记文本。
注记注释也可以用作标记注释的回复或状态注释:

  • 当作为回复时,注记注释不应单独显示,而应与其他回复一起以线程评论的形式显示。 函数 FSNote::getReplyTo 可用于获取注记注释回复的标记注释。
  • 当作为状态时,注记注释不会单独显示。函数 FSNote::isStateAnnot 可用于判断注记注释是否用作状态。

注记注释是一种标记注释,因此类 FSNote 派生自 类 FSMarkup 。它提供获取/设置注记注释属性和 重置注记注释外观的函数。

注解
对于新创建的普通注记注释,如果用户直接调用函数 FSAnnot::resetAppearanceStream 而不设置任何属性,将使用默认外观:
边框颜色 = 0xFFFFFF00(黄色),不透明度 = 1.0,图标名称 = "Comment"。
参见
FSMarkup

函数文档

◆ getReplyTo()

- (FSMarkup *) getReplyTo

获取当前注记注释回复的标记注释。

此函数仅在当前注记注释用作回复时有用。

返回
当前注记注释回复的标记注释对象。 如果返回的标记注释对象的函数 FSAnnot::isEmpty (从 Markup 的父类继承) 的返回值为 YES,则表示当前注记注释不用作回复。

◆ getStateModel()

- (FSMarkupStateModel) getStateModel

获取状态模型。

此函数只能在当前注记注释用作状态注释时使用。 函数 FSNote::isStateAnnot 可用于检查当前注记注释是否用作状态注释。

返回
状态模型。如果函数成功,返回值将是 FSMarkupStateModelMarked 或 FSMarkupStateModelReview 。
如果当前注记注释不是状态注释,此函数将返回 0。

◆ initWithAnnot:()

- (id) initWithAnnot: (FSAnnot*)  annot

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

参数
[in]annot父类对象。

重载 FSMarkup .

◆ isStateAnnot()

- (BOOL) isStateAnnot

检查当前注记注释是否用作状态注释。

返回
YES 表示当前注记注释用作状态注释, NO 表示当前注记注释只是普通的注记注释。

属性说明

◆ iconName

- (NSString *) iconName
readwritenonatomicweak

获取图标名称。

此属性对便签注释的外观有影响。便签注释具有预定义的标准图标 名称:
"Check"、"Circle"、"Comment"、"Cross"、"Help"、"Insert"、"Key"、"NewParagraph"、"Note"、"Paragraph"、 "RightArrow"、"RightPointer"、"Star"、"UpArrow"、"UpLeftArrow"。
空的图标名称字符串表示当前便签注释将被视为"Note"图标。

◆ openStatus

- (BOOL) openStatus
readwritenonatomicassign

获取开放状态。

开放状态是一个布尔值,指定注记注释是否应初始显示为打开状态:

  • YES 表示注记注释应初始显示为打开状态。
  • NO 表示注记注释应初始显示为关闭状态。


◆ state

- (FSMarkupState) state
readwritenonatomicassign

获取状态。

此函数只能在当前注记注释用作状态注释时使用。 函数 FSNote::isStateAnnot 可用于检查当前注记注释是否用作状态注释。