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

构造函数

(void) - allowTextOverflow:
 决定是否允许自由文本的文本溢出。
更多...
 
(FSDefaultAppearance *) - getDefaultAppearance
 获取默认外观数据。
更多...
 
(id) - init
 构造函数。

 
(id) - initWithAnnot:
 构造函数,使用父类对象。
更多...
 
(void) - rotate:
 从当前状态按指定旋转值(顺时针)旋转当前注释。
更多...
 
(BOOL) - setDefaultAppearance:
 设置默认外观数据。
更多...
 
- 构造函数 继承自 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
 重置外观流。
更多...
 

属性

FSAlignment alignment
 获取对齐值。
更多...
 
FSMarkupEndingStyle calloutLineEndingStyle
 获取标注线起点的线条结束样式。
更多...
 
FSPointFArray * calloutLinePoints
 获取标注线点。
更多...
 
unsigned int fillColor
 获取填充颜色。
更多...
 
FSRectF * innerRect
 获取内部矩形。
更多...
 
FSRotation rotation
 获取当前旋转值(顺时针)。

 
FSMatrix2D * textMatrix
 获取当前自由文本注释中文本的默认外观数据中的矩阵。
更多...
 
- 属性 继承自 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。

 

详细描述

自由文本注释直接在页面上显示文本。因此自由文本注释不需要相关的弹出注释来显示文本。
自由文本注释是一种标记注释,所以类 FSFreeText 派生自 类 FSMarkup ,并且还提供了获取/设置自由文本注释属性和 重置自由文本注释外观流的函数。

注解
对于新创建的自由文本注释,如果用户直接调用函数 FSAnnot::resetAppearanceStream 而不设置任何属性,将使用默认外观:
边框宽度 = 1.0,边框样式 = FSBorderInfoSolid , 边框颜色 = 0xFFFF0000(红色),不透明度 = 1.0,对齐方式 = 0(左对齐), 默认外观标志 = FSDefaultAppearanceFlagFont | FSDefaultAppearanceFlagTextColor | FSDefaultAppearanceFlagFontSize , 默认外观字体基于 FSFontStdIDHelvetica 创建, 默认外观文本大小 = 12,默认外观文本颜色 = 0xFF0000FF(蓝色)。
参见
FSMarkup

函数文档

◆ allowTextOverflow:()

- (void) allowTextOverflow: (BOOL)  is_text_overflow

决定是否允许自由文本的文本溢出。

对于标注对象和文本框对象,如果未调用此函数,默认情况下标注或文本框的文本允许溢出。 对于打字机对象,如果未调用此函数,默认情况下打字机的文本不允许溢出。

参数
[in]is_text_overflow决定当自由文本矩形的大小小于文本内容大小时, 是否允许文本内容溢出的布尔值:
  • YES表示文本内容允许溢出。在这种情况下, 溢出的文本内容将被截断。
  • NO表示文本内容不允许溢出。在这种情况下, 标注矩形将自动适应以包含整个文本内容。

返回
无。

◆ getDefaultAppearance()

- (FSDefaultAppearance *) getDefaultAppearance

获取默认外观数据。

此属性对自由文本注释的外观有影响。默认外观数据可用于 格式化文本。

返回
默认外观数据。

◆ initWithAnnot:()

- (id) initWithAnnot: (FSAnnot*)  annot

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

参数
[in]annot父类对象。

重载 FSMarkup .

◆ rotate:()

- (void) rotate: (FSRotation)  rotation

从当前状态按指定旋转值(顺时针)旋转当前注释。

参数
[in]rotation表示用于从当前状态顺时针旋转当前注释的度数的旋转值。 请参考从 FSRotation0 开始的值, 这应该是这些值中的一个,除了 FSRotationUnknown 。 特别地,如果输入值是 FSRotation0 (意味着不旋转当前注释),当前函数将不执行任何操作。
返回
YES表示成功,而NO表示失败。

◆ setDefaultAppearance:()

- (BOOL) setDefaultAppearance: (FSDefaultAppearance*)  default_ap

设置默认外观数据。

此属性对自由文本注释的外观有影响。默认外观数据可用于 格式化文本。
如果用户希望新的默认外观数据对注释外观产生效果, 请在设置新默认外观数据后调用函数 FSAnnot::resetAppearanceStream 。

参数
[in]default_ap要设置的新默认外观数据。 输入数据的flags可用于决定哪些信息将用新数据更新; 对于那些不更新的数据,它们将继续使用旧数据。
返回
YES表示成功,而NO表示失败。 特别地,如果参数default_ap包含任何不正确的值, 此函数将返回NO,例如:

属性说明

◆ alignment

- (FSAlignment) alignment
readwritenonatomicassign

获取对齐值。

弃用:
当前函数自福昕PDF SDK 8.2起已被弃用。此属性将不再对自由文本注释的外观 产生任何影响。要获取对齐属性,请调用函数 FSMarkup::getRichTextStyle: 。 有关RichText相关函数的更多详细信息,请参考 FSMarkup 。

此属性对自由文本注释的外观有影响。

◆ calloutLineEndingStyle

- (FSMarkupEndingStyle) calloutLineEndingStyle
readwritenonatomicassign

获取标注线起点的线条结束样式。

只有当自由文本注释的意图名称为"FreeTextCallout"时, 此自由文本注释才能具有线条结束样式属性,且此属性对这种 自由文本注释的外观有影响。

◆ calloutLinePoints

- (FSPointFArray *) calloutLinePoints
readwritenonatomicweak

获取标注线点。

只有当自由文本注释的意图名称为"FreeTextCallout"时,此自由文本注释才能 具有标注线点属性,且此属性对这种自由文本注释的外观有影响。对于标注线, 它可以包含2个或3个点:

  • 2个点表示标注线的起点和终点。
  • 3个点表示标注线的起点、拐点和终点。


◆ fillColor

- (unsigned int) fillColor
readwritenonatomicassign

获取填充颜色。

此属性对自由文本注释的外观有影响。填充颜色用于填充 文本框的背景,也用于某些标注线结束样式:
"Square"、"Circle"、"Diamond"、"ClosedArrow"、"RClosedArrow"。

◆ innerRect

- (FSRectF *) innerRect
readwritenonatomicweak

获取内部矩形。

此属性对自由文本注释的外观有影响。对于自由文本注释, 内部矩形是应该显示注释文本的位置。内部矩形可能与注释矩形相同 或小于注释矩形,但绝不应大于注释矩形。

◆ textMatrix

- (FSMatrix2D *) textMatrix
readwritenonatomicweak

获取当前自由文本注释中文本的默认外观数据中的矩阵。

弃用:
当前函数自福昕PDF SDK 7.4起已被弃用。此属性将不再对注释外观 产生任何影响。

此属性对自由文本注释的外观有影响。此属性可用于 改变文本显示的倾斜度。