Foxit PDF SDK

Public 成员函数 | 所有成员列表
FSDK::FreeText类 参考

自由文本注释在页面上直接显示文本。 更多...

类 FSDK::FreeText 继承关系图:

## Public 成员函数
| AllowTextOverflow (is_text_overflow)
| 决定是否允许自由文本的文本溢出。 更多...
| constructor ()
| 构造函数。
| constructor (annot)
| 带有父类的回调。 更多...
| GetAlignment ()
| 获取对齐值。 更多...
| GetCalloutLineEndingStyle ()
| 获取标注线起始点的线结束样式。 更多...
| GetCalloutLinePoints ()
| 获取标注线点。 更多...
| GetDefaultAppearance ()
| 获取默认外观数据。 更多...
| GetFillColor ()
| 获取填充颜色。 更多...
| GetInnerRect ()
| 获取内矩形。 更多...
| GetRotation ()
| 获取当前旋转值（顺时针）。 更多...
| GetTextMatrix ()
| 获取当前自由文本注释中文本的默认外观数据中的矩阵。 更多...
| Rotate (rotation)
| 从当前状态使用指定的旋转值（顺时针）旋转当前注释。 更多...
| SetAlignment (alignment)
| 设置对齐值 更多...
| SetCalloutLineEndingStyle (ending_style)
| 设置标注线起始点的线结束样式。 更多...
| SetCalloutLinePoints (point_array)
| 设置标注线的点。 更多...
| SetDefaultAppearance (default_ap)
| 设置默认外观数据。 更多...
| SetFillColor (fill_color)
| 设置填充颜色。 更多...
| SetInnerRect (inner_rect)
| 设置内矩形。 更多...
| SetRotation (rotation)
| 设置旋转值（顺时针）。 更多...
| SetTextMatrix (text_matrix)
| 为当前自由文本注释中的文本设置默认外观数据中的矩阵。 更多...
Public 成员函数 继承自 FSDK::Markup
| AddReply ()
| 将新回复添加到回复列表的末尾。 更多...
| AddRichText (content, style)
| 将新的富文本字符串添加到末尾。 更多...
| AddStateAnnot (title, model, state)
| 添加新的状态注释。 更多...
| constructor (annot)
| 带有父类对象的构造函数。 更多...
| constructor ()
| 构造函数。
| GetBorderOpacity ()
| 获取注释的边框不透明度。 更多...
| GetCreationDateTime ()
| 获取创建日期时间。 更多...
| GetFillOpacity ()
| 获取注释的填充不透明度。 更多...
| GetGroupElements ()
| 从当前标记注释所属的组中获取元素（作为标记注释）。 更多...
| GetGroupHeader ()
| 获取当前标记注释所属组的标头注释（作为主注释）。 更多...
| GetIntent ()
| 获取意图名称。 更多...
| GetOpacity ()
| 获取不透明度值。 更多...
| GetPopup ()
| 获取相关的弹出注释。 更多...
| GetReply (index)
| 根据索引获取回复。 更多...
| GetReplyCount ()
| 计算所有回复的数量。 更多...
| GetRichTextContent (index)
| 获取由索引指定的富文本字符串的文本字符串。 更多...
| GetRichTextCount ()
| 获取富文本字符串的数量。 更多...
| GetRichTextStyle (index)
| 获取由索引指定的富文本字符串的样式数据。 更多...
| GetStateAnnots (model)
| 获取指定状态模型中的所有状态注释。 更多...
| GetSubject ()
| 获取主题字符串。 更多...
| GetTitle ()
| 获取标题字符串。 更多...
| InsertRichText (index, content, style)
| 将新的富文本字符串插入到由索引指定的位置。 更多...
| IsGrouped ()
| 检查当前标记注释是否在组中。 更多...
| RemoveAllReplies ()
| 删除所有回复。 更多...
| RemoveAllStateAnnots ()
| 删除所有状态注释。 更多...
| RemovePopup ()
| 移除相关的弹出注释。 更多...
| RemoveReply (index)
| 根据索引删除回复。 更多...
| RemoveRichText (index)
| 删除由索引指定的富文本字符串。 更多...
| SetBorderOpacity (opacity)
| 设置注释的边框不透明度。 更多...
| SetCreationDateTime (date_time)
| 设置创建日期时间。 更多...
| SetFillOpacity (opacity)
| 设置注释的填充不透明度。 更多...
| SetIntent (intent)
| 设置意图名称。 更多...
| SetOpacity (opacity)
| 设置不透明度值。 更多...
| SetPopup (popup)
| 设置相关的弹出注释。 更多...
| SetRichTextContent (index, content)
| 设置由索引指定的富文本字符串的文本字符串。 更多...
| SetRichTextStyle (index, style)
| 设置由索引指定的富文本字符串的样式数据。 更多...
| SetSubject (subject)
| 设置主题字符串。 更多...
| SetTitle (title)
| 设置标题字符串。 更多...
| Ungroup ()
| 将当前标记注释从其所属的组中取消分组。 更多...
Public 成员函数 继承自 FSDK::Annot
| constructor (page, annot_dict)
| 带有PDF页面和注释的PDF字典的构造函数。 更多...
| constructor ()
| 构造函数。
| GetAppearanceStream (type, appearance_state)
| 获取具有指定类型和状态的注释外观流。 更多...
| GetBorderColor ()
| 获取边框颜色。 更多...
| GetBorderInfo ()
| 获取边框信息。 更多...
| GetContent ()
| 获取内容。 更多...
| GetDeviceRect (matrix)
| 获取设备坐标系中的注释矩形。 更多...
| GetDict ()
| 获取注释的字典对象。 更多...
| GetDisplayMatrix (page_display_matrix)
| 获取从PDF坐标系到 目标设备坐标系的显示矩阵。 更多...
| GetFlags ()
| 获取注释标志。 更多...
| GetIndex ()
| 获取当前注释在其所属页面中的索引。 更多...
| GetModifiedDateTime ()
| 获取上次修改日期时间。 更多...
| GetOptionalContent ()
| 获取注释的可选内容的PDF字典。 更多...
| GetPage ()
| 获取相关的PDF页面。 更多...
| GetRect ()
| 获取PDF坐标系中的矩形。 更多...
| GetType ()
| 获取当前注释的实际注释类型。 更多...
| GetUniqueID ()
| 获取唯一ID。 更多...
| HasProperty (property)
| 当前注释是否具有指定的注释属性。 更多...
| IsEmpty ()
| 检查当前对象是否为空。 更多...
| IsMarkup ()
| 检查当前注释是否为标记注释。 更多...
| Move (rect)
| 将当前注释移动到新位置，由PDF坐标系中的新矩形指定。 更多...
| Move (rect, is_reset_appearance)
| 将当前注释移动到新位置，由PDF坐标系中的新矩形指定。 更多...
| RemoveProperty (property)
| 移除指定的注释属性。 更多...
| ResetAppearanceStream ()
| 重置外观流。 更多...
| ResetAppearanceStream (is_generate_new_appearance_obj)
| 重置外观流。 更多...
| SetBorderColor (color)
| 设置边框颜色。 更多...
| SetBorderInfo (border)
| 设置边框信息。 更多...
| SetContent (content)
| 设置内容。 更多...
| SetFlags (flags)
| 设置注释标志。 更多...
| SetModifiedDateTime (date_time)
| 设置上次修改日期时间。 更多...
| SetUniqueID (unique_id)
| 设置唯一ID。 更多...

## 额外继承的成员函数
静态 Public 属性 继承自 FSDK::Markup
static | e_EndingStyleButt
| 端点处垂直于线条本身的短线。
static | e_EndingStyleCircle
| 用注释的内部颜色（如果有）填充的圆形。
static | e_EndingStyleClosedArrow
| 两条短线以锐角相遇，如OpenArrow样式，并由 第三条线连接形成三角形闭合箭头，用注释的内部颜色（如果有）填充。
static | e_EndingStyleDiamond
| 用注释的内部颜色（如果有）填充的菱形。
static | e_EndingStyleNone
| 线条结束样式的枚举。 更多...
static | e_EndingStyleOpenArrow
| 两条短线以锐角相遇形成开放箭头。
static | e_EndingStyleRClosedArrow
| 与ClosedArrow相反方向的三角形闭合箭头。
static | e_EndingStyleROpenArrow
| 两条短线与OpenArrow相反的方向。
static | e_EndingStyleSlash
| 端点处与线条本身大约30度顺时针方向的短线。
static | e_EndingStyleSquare
| 用注释的内部颜色（如果有）填充的正方形。
static | e_MeasureTypeA
| 面积的测量。
static | e_MeasureTypeD
| 任何方向距离的测量。
static | e_MeasureTypeS
| 线条斜率的测量。
static | e_MeasureTypeT
| 角度的测量。
static | e_MeasureTypeX
| 注释度量类型的枚举。 更多...
static | e_MeasureTypeY
| 沿 y轴变化的测量。
static | e_StateAccepted
| （与状态模型 FSDK.Markup.e_StateModelReview 一起使用） 用户同意更改。
static | e_StateCancelled
| （与状态模型 FSDK.Markup.e_StateModelReview 一起使用） 更改已被取消。
static | e_StateCompleted
| （与状态模型 FSDK.Markup.e_StateModelReview 一起使用） 更改已完成。
static | e_StateDeferred
| （与状态模型 FSDK.Markup.e_StateModelReview 一起使用） 更改已被推迟。
static | e_StateFuture
| （与状态模型 FSDK.Markup.e_StateModelReview 一起使用） 更改将在未来进行。
static | e_StateMarked
| （与状态模型 FSDK.Markup.e_StateModelMarked 一起使用） 注释已被用户标记。
static | e_StateModelMarked
| 标记注释状态模型的枚举。 更多...
static | e_StateModelReview
| 标记注释状态模型：审阅。
static | e_StateNone
| 标记注释状态的枚举。 更多...
static | e_StateRejected
| （与状态模型 FSDK.Markup.e_StateModelReview 一起使用） 用户不同意更改。
static | e_StateUnmarked
| （与状态模型 FSDK.Markup.e_StateModelMarked 一起使用） 注释未被用户标记。
静态 Public 属性 继承自 FSDK::Annot
static | e_3D
| 注释类型：3D注释。<PDF reference 1.7>中的标准注释之一。
static | e_AppearanceTypeDown
| 注释的按下外观。
static | e_AppearanceTypeNormal
| 注释外观类型的枚举。 更多...
static | e_AppearanceTypeRollover
| 注释的翻转外观。
static | e_Caret
| 注释类型：插入符注释。<PDF reference 1.7>中的标准注释之一。
static | e_Circle
| 注释类型：圆形注释。<PDF reference 1.7>中的标准注释之一。
static | e_FileAttachment
| 注释类型：文件附件注释。<PDF reference 1.7>中的标准注释之一。
static | e_FlagHidden
| 注释标志：隐藏。 更多...
static | e_FlagInvisible
| PDF注释标志的枚举。 更多...
static | e_FlagLocked
| 注释标志：锁定。 更多...
static | e_FlagLockedContents
| 注释标志：锁定内容。 更多...
static | e_FlagNoRotate
| 注释标志：不旋转。 更多...
static | e_FlagNoView
| 注释标志：不查看。 更多...
static | e_FlagNoZoom
| 注释标志：不缩放。 更多...
static | e_FlagPrint
| 注释标志：打印。 更多...
static | e_FlagReadOnly
| 注释标志：只读。 更多...
static | e_FlagToggleNoView
| 注释标志：切换不查看。 更多...
static | e_FreeText
| 注释类型：自由文本注释。<PDF reference 1.7>中的标准注释之一。
static | e_Highlight
| 注释类型：高亮注释。<PDF reference 1.7>中的标准注释之一。
static | e_HighlightingInvert
| 高亮模式：反转，即反转注释矩形的内容。
static | e_HighlightingNone
| PDF注释高亮模式的枚举。 更多...
static | e_HighlightingOutline
| 高亮模式：轮廓，即反转注释的边框。
static | e_HighlightingPush
| 高亮模式：按下，即显示注释的按下外观（如果有）。
static | e_HighlightingToggle
| 高亮模式：切换。这仅对小部件注释有用。
static | e_Ink
| 注释类型：墨迹注释。<PDF reference 1.7>中的标准注释之一。
static | e_Line
| 注释类型：直线注释。<PDF reference 1.7>中的标准注释之一。
static | e_Link
| 注释类型：链接注释。<PDF reference 1.7>中的标准注释之一。
static | e_MKEntryBackgroundColor
| 背景颜色条目。MK字典中的"BG"。
static | e_MKEntryBorderColor
| 边框颜色条目。MK字典中的"BC"。
static | e_MKEntryDownCaption
| 按下标题（或替代标题）条目。MK字典中的"AC"。 更多...
static | e_MKEntryDownIcon
| 按下图标（或替代图标）条目。MK字典中的"IX"。 更多...
static | e_MKEntryIconCaptionRelation
| 图标和标题关系条目。MK字典中的"TP"。 更多...
static | e_MKEntryIconFit
| 图标适配信息条目。MK字典中的"IF"。 更多...
static | e_MKEntryNormalCaption
| 正常标题条目。MK字典中的"CA"。 更多...
static | e_MKEntryNormalIcon
| 正常图标条目。MK字典中的"I"。 更多...
static | e_MKEntryRolloverCaption
| 翻转标题条目。MK字典中的"RC"。 更多...
static | e_MKEntryRolloverIcon
| 翻转图标条目。MK字典中的"RI"。 更多...
static | e_MKEntryRotation
| 注释的MK字典（外观特性）条目的枚举。 更多...
static | e_MKRelationCaptionAboveIcon
| 标题在图标上方。
static | e_MKRelationCaptionBelowIcon
| 标题在图标下方。
static | e_MKRelationCaptionLeft
| 标题在图标左侧。
static | e_MKRelationCaptionOvrlayOnIcon
| 标题直接覆盖在图标上。
static | e_MKRelationCaptionRight
| 标题在图标右侧。
static | e_MKRelationNoCaption
| 无标题；仅图标。
static | e_MKRelationNoIcon
| 注释的MK字典中图标和标题相对位置的枚举。 更多...
static | e_Movie
| 注释类型：电影注释。<PDF reference 1.7>中的标准注释之一。
static | e_Note
| 注释类型：注释注释，即“文本”注释 - <PDF reference 1.7>中的标准注释之一。
static | e_PagingSeal
| 注释类型：分页印章注释。Foxit PDF SDK自定义注释类型（非标准注释类型）。
static | e_Polygon
| 注释类型：多边形注释。<PDF reference 1.7>中的标准注释之一。
static | e_PolyLine
| 注释类型：折线注释。<PDF reference 1.7>中的标准注释之一。
static | e_Popup
| 注释类型：弹出注释。<PDF reference 1.7>中的标准注释之一。
static | e_PrinterMark
| 注释类型：印刷商标记注释。<PDF reference 1.7>中的标准注释之一。
static | e_PropertyBorderColor
| 注释属性：边框颜色。 更多...
static | e_PropertyCreationDate
| 注释属性：创建日期。 更多...
static | e_PropertyFillColor
| 注释属性：填充颜色 更多...
static | e_PropertyModifiedDate
| 某些PDF注释属性的枚举。 更多...
static | e_PSInk
| 注释类型：压感墨迹注释。
static | e_Redact
| 注释类型：涂黑注释。
static | e_RichMedia
| 注释类型：富媒体注释。
static | e_Screen
| 注释类型：屏幕注释。<PDF reference 1.7>中的标准注释之一。
static | e_Sound
| 注释类型：声音注释。<PDF reference 1.7>中的标准注释之一。
static | e_Square
| 注释类型：正方形注释。<PDF reference 1.7>中的标准注释之一。
static | e_Squiggly
| 注释类型：波浪线注释。<PDF reference 1.7>中的标准注释之一。
static | e_Stamp
| 注释类型：图章注释。<PDF reference 1.7>中的标准注释之一。
static | e_StrikeOut
| 注释类型：删除线注释。<PDF reference 1.7>中的标准注释之一。
static | e_TrapNet
| 注释类型：陷阱网络注释。<PDF reference 1.7>中的标准注释之一。
static | e_Underline
| 注释类型：下划线注释。<PDF reference 1.7>中的标准注释之一。
static | e_UnknownType
| PDF注释类型的枚举。 更多...
static | e_Watermark
| 注释类型：水印注释。<PDF reference 1.7>中的标准注释之一。
static | e_Widget
| 注释类型：小部件注释。<PDF reference 1.7>中的标准注释之一。 更多...

## 详细描述

自由文本注释在页面上直接显示文本。

因此自由文本注释不需要相关的弹出注释来显示文本。
自由文本注释是一种标记注释，因此类 FSDK.FreeText 派生自 类 FSDK.Markup，并且还提供了获取/设置自由文本注释属性和 重置自由文本注释外观流的函数。

注解
  对于新创建的自由文本注释，如果用户在不设置任何属性的情况下直接调用函数 FSDK.Annot.ResetAppearanceStream，将使用默认外观：
  边框宽度 = 1.0，边框样式 = FSDK.BorderInfo.e_Solid， 边框颜色 = 0xFFFF0000 (红色)，不透明度 = 1.0，对齐方式 = 0 (左对齐)， 默认外观标志 = FSDK.DefaultAppearance.e_FlagFont| FSDK.DefaultAppearance.e_FlagTextColor| FSDK.DefaultAppearance.e_FlagFontSize， 默认外观字体基于 FSDK.Font.e_StdIDHelvetica 创建， 默认外观文本大小 = 12，默认外观文本颜色 = 0xFF0000FF (蓝色)。

参见
  FSDK.Markup

## 成员函数说明

## ◆ AllowTextOverflow()

FSDK::FreeText::AllowTextOverflow | ( | is_text_overflow |  | ) |

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

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

参数

  [in] | is_text_overflow | 一个布尔值，用于决定当自由文本矩形的大小小于文本内容的大小时， 是否允许文本内容溢出： true 表示允许文本内容溢出。因此在这种情况下， 溢出的文本内容将被截断。 false 表示不允许文本内容溢出。因此在这种情况下， 标注矩形将自动调整以包含整个文本内容。

返回
  None.

## ◆ constructor()

FSDK::FreeText::constructor | ( | annot |  | ) |

带有父类的回调。

参数

  [in] | annot | 父类回调对象。

## ◆ GetAlignment()

FSDK::FreeText::GetAlignment | ( |  | ) |

获取对齐值。

弃用:
  自 Foxit PDF SDK 8.2 起，此函数已被弃用。此属性将不再 对自由文本注释的外观产生任何影响。要获取对齐属性， 请调用函数 FSDK.Markup.GetRichTextStyle。请参考 FSDK.Markup 中的 RichText 相关函数以了解更多详情。

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

返回
  对齐值。请参考从 FSDK.e_AlignmentLeft 开始的值， 这将是这些值之一。

## ◆ GetCalloutLineEndingStyle()

FSDK::FreeText::GetCalloutLineEndingStyle | ( |  | ) |

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

仅当自由文本注释的意图名称为 "FreeTextCallout" 时， 此自由文本注释才能具有线结束样式属性，并且此属性会影响此类 自由文本注释的外观。

返回
  起始点的线结束样式。请参考从 FSDK.Markup.e_EndingStyleNone 开始的值，这将是这些值之一。

## ◆ GetCalloutLinePoints()

FSDK::FreeText::GetCalloutLinePoints | ( |  | ) |

获取标注线点。

仅当自由文本注释的意图名称为 "FreeTextCallout" 时，此自由文本注释才能 具有标注线点属性，并且此属性会影响此类自由文本注释的 外观。对于标注线，它可以包含 2 个或 3 个点：

- 2 个点表示标注线的起始点和结束点。
- 3 个点表示标注线的起始点、膝点和结束点。

返回
  表示标注自由文本注释的标注线所用点的点数组。

## ◆ GetDefaultAppearance()

FSDK::FreeText::GetDefaultAppearance | ( |  | ) |

获取默认外观数据。

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

返回
  默认外观数据。

## ◆ GetFillColor()

FSDK::FreeText::GetFillColor | ( |  | ) |

获取填充颜色。

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

返回
  填充颜色。格式：0xRRGGBB。 如果找不到填充颜色，将返回 0x000000。

## ◆ GetInnerRect()

FSDK::FreeText::GetInnerRect | ( |  | ) |

获取内矩形。

此属性会影响自由文本注释的外观。对于自由文本注释， 内矩形是注释文本应该显示的位置。内矩形可以 与注释的矩形相同或小于注释的矩形，并且永远不应大于 注释的矩形。

返回
  内矩形。

## ◆ GetRotation()

FSDK::FreeText::GetRotation | ( |  | ) |

获取当前旋转值（顺时针）。

返回
  当前旋转值（顺时针）。请参考从 FSDK.e_Rotation0 开始的值，这将是这些值之一。

## ◆ GetTextMatrix()

FSDK::FreeText::GetTextMatrix | ( |  | ) |

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

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

此属性会影响自由文本注释的外观。此属性可用于 更改文本显示的倾斜。

返回
  用于默认外观中文本的矩阵。

## ◆ Rotate()

FSDK::FreeText::Rotate | ( | rotation |  | ) |

从当前状态使用指定的旋转值（顺时针）旋转当前注释。

参数

  [in] | rotation | 表示用于从当前状态顺时针旋转当前注释的角度的旋转值。 请参考从 FSDK.e_Rotation0 开始的值， 这应该是这些值之一，但不包括 FSDK.e_RotationUnknown。 特别地，如果输入值为 FSDK.e_Rotation0（表示不旋转当前注释）， 当前函数将不执行任何操作。

返回
  true 表示成功，而 false 表示失败。

## ◆ SetAlignment()

FSDK::FreeText::SetAlignment | ( | alignment |  | ) |

设置对齐值

弃用:
  自 Foxit PDF SDK 8.2 起，此函数已被弃用。此属性将不再 对自由文本注释的外观产生任何影响。要设置对齐属性， 请调用函数 FSDK.Markup.SetRichTextStyle。请参考 FSDK.Markup 中的 RichText 相关函数以了解更多详情。

此属性会影响自由文本注释的外观。如果用户希望新的对齐方式影响 注释的外观，请在设置新的对齐方式后调用函数 FSDK.Annot.ResetAppearanceStream。

参数

  [in] | alignment | 新的对齐值。请参考从 FSDK.e_AlignmentLeft 开始的值， 这应该是这些值之一。 如果使用其他值设置，默认将使用 FSDK.e_AlignmentLeft。

返回
  None.

## ◆ SetCalloutLineEndingStyle()

FSDK::FreeText::SetCalloutLineEndingStyle | ( | ending_style |  | ) |

设置标注线起始点的线结束样式。

仅当自由文本注释的意图名称为 "FreeTextCallout" 时， 此自由文本注释才能具有线结束样式属性，并且此属性会影响此类 自由文本注释的外观。
如果用户希望新的线结束样式影响注释的外观，请在设置新的线结束样式后 调用函数 FSDK.Annot.ResetAppearanceStream。

参数

  [in] | ending_style | 要设置的起始点的线结束样式。请参考从 FSDK.Markup.e_EndingStyleNone 开始的值，这应该是这些值之一。

返回
  None.

## ◆ SetCalloutLinePoints()

FSDK::FreeText::SetCalloutLinePoints | ( | point_array |  | ) |

设置标注线的点。

仅当自由文本注释的意图名称为 "FreeTextCallout" 时，此自由文本注释才能 具有标注线点属性，并且此属性会影响此类自由文本注释的 外观。对于标注线，它可以包含 2 个或 3 个点：

- 2 个点表示标注线的起始点和结束点。
- 3 个点表示标注线的起始点、膝点和结束点。

如果用户希望新的标注线点影响注释的外观，请在设置新的标注线点后 调用函数 FSDK.Annot.ResetAppearanceStream。

参数

  [in] | point_array | 指定标注线的起始点、膝点（如果有）和结束点的新点数组。 元素数量应为 2 或 3： 2 个点表示起始点和结束点；3 个点表示起始点、 膝点和结束点。 如果元素数量超过 3，则只有前 3 个点将用于 设置标注线。

返回
  None.

## ◆ SetDefaultAppearance()

FSDK::FreeText::SetDefaultAppearance | ( | default_ap |  | ) |

设置默认外观数据。

此属性会影响自由文本注释的外观。默认外观数据可用于 格式化文本。
如果用户希望新的默认外观数据影响注释的外观， 请在设置新的默认外观数据后调用函数 FSDK.Annot.ResetAppearanceStream。

参数

  [in] | default_ap | 要设置的新默认外观数据。 输入数据的 flags 可用于决定哪些信息将 使用新数据更新；对于那些未更新的数据，它们将继续使用旧数据。

返回
  true 表示成功，而 false 表示失败。 特别地，如果参数 default_ap 包含任何不正确的值， 此函数将返回 false，例如：
  - 输入数据的 flags 包括 FSDK.DefaultAppearance.e_FlagFont 但输入数据的 font 无效。
  - 输入数据的 flags 包括 FSDK.DefaultAppearance.e_FlagFontSize 但输入数据的 text size 不大于零。

## ◆ SetFillColor()

FSDK::FreeText::SetFillColor | ( | fill_color |  | ) |

设置填充颜色。

此属性会影响自由文本注释的外观。填充颜色用于填充文本框的背景， 也用于一些标注线结束样式：
"Square"、"Circle"、"Diamond"、"ClosedArrow"、"RClosedArrow"。
如果用户希望新的填充颜色影响注释的外观，请在设置新的填充颜色后 调用函数 FSDK.Annot.ResetAppearanceStream。

参数

  [in] | fill_color | 要设置的新填充颜色。格式：0xRRGGBB。

返回
  None.

## ◆ SetInnerRect()

FSDK::FreeText::SetInnerRect | ( | inner_rect |  | ) |

设置内矩形。

此属性会影响自由文本注释的外观。对于自由文本注释， 内矩形是注释文本应该显示的位置。内矩形可以 与注释的矩形相同或小于注释的矩形，并且永远不应大于 注释的矩形。
如果用户希望新的内矩形影响注释的外观，请在设置新的内矩形后 调用函数 FSDK.Annot.ResetAppearanceStream。

参数

  [in] | inner_rect | 要设置的新内矩形。它应该与注释的矩形相同或小于注释的矩形。

返回
  None.

## ◆ SetRotation()

FSDK::FreeText::SetRotation | ( | rotation |  | ) |

设置旋转值（顺时针）。

此属性会影响自由文本注释的外观。如果用户希望新的旋转 影响注释的外观，请在设置新的旋转后调用函数 FSDK.Annot.ResetAppearanceStream。

参数

  [in] | rotation | 要设置到当前自由文本注释的新旋转值（顺时针）。 请参考从 FSDK.e_Rotation0 开始的值， 这应该是这些值之一，但不包括 FSDK.e_RotationUnknown。

返回
  None.

## ◆ SetTextMatrix()

FSDK::FreeText::SetTextMatrix | ( | text_matrix |  | ) |

为当前自由文本注释中的文本设置默认外观数据中的矩阵。

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

此属性会影响自由文本注释的外观。此属性可用于 更改文本显示的倾斜。
如果用户希望新的文本矩阵影响注释的外观，请在设置新的文本矩阵后 调用函数 FSDK.Annot.ResetAppearanceStream。

参数

  [in] | text_matrix | 新的文本矩阵。

返回
  None.