Foxit PDF SDK

Public 成员函数 | 所有成员列表
FSDK::Ink类 参考
类 FSDK::Ink 继承关系图:

## Public 成员函数
| constructor ()
| 构造函数。
| constructor (annot)
| 构造函数，带有父类对象。 更多...
| EnableUseBezier (use_bezier)
| 启用使用贝塞尔样条曲线为墨迹注释的外观生成墨迹路径。 更多...
| GetInkList ()
| 获取墨迹列表数据。 更多...
| SetInkList (ink_list)
| 设置墨迹列表数据。 更多...
Public 成员函数 继承自 FSDK::Markup
| AddReply ()
| 将新回复添加到回复列表的末尾。 更多...
| AddRichText (content, style)
| 将新的富文本字符串添加到末尾。 更多...
| AddStateAnnot (title, model, state)
| 添加新的状态注释。 更多...
| constructor ()
| 构造函数。
| constructor (annot)
| 带有父类对象的构造函数。 更多...
| 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 ()
| 构造函数。
| constructor (page, annot_dict)
| 带有PDF页面和注释的PDF字典的构造函数。 更多...
| 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.Ink 派生自 类 FSDK.Markup，提供了获取/设置墨迹注释属性以及重置墨迹注释的外观流的函数。
对于墨迹注释，墨迹列表属性是必需的。因此，请确保墨迹注释在重置其外观流之前 具有有效的墨迹列表属性；否则无法重置墨迹注释的外观流。

注解
  对于新创建的墨迹注释，如果用户在设置必需的墨迹列表属性后直接调用函数 FSDK.Annot.ResetAppearanceStream（从 FSDK.Ink 的父类继承） 而不设置任何其他属性，将使用默认外观：
  边框宽度 = 2.0，边框样式 = FSDK.BorderInfo.e_Solid， 边框颜色 = 0xFFFF0000（红色），不透明度 = 1.0。

参见
  FSDK.Markup

## 成员函数说明

## ◆ constructor()

FSDK::Ink::constructor | ( | annot |  | ) |

构造函数，带有父类对象。

参数

  [in] | annot | 父类对象。

## ◆ EnableUseBezier()

FSDK::Ink::EnableUseBezier | ( | use_bezier |  | ) |

启用使用贝塞尔样条曲线为墨迹注释的外观生成墨迹路径。

如果不调用此函数，Foxit PDF SDK 将默认使用贝塞尔样条曲线生成墨迹路径。

参数

  [in] | use_bezier | 一个布尔值，用于决定是否使用贝塞尔样条曲线： true 表示使用贝塞尔样条曲线生成墨迹路径， 而 false 表示使用直线连接相邻点来生成墨迹路径。

返回
  None.

## ◆ GetInkList()

FSDK::Ink::GetInkList | ( |  | ) |

获取墨迹列表数据。

墨迹列表属性对于墨迹注释是必需的，此属性会影响墨迹注释的外观。 墨迹列表包含一个或多个笔画路径。
在 Foxit PDF SDK 中，使用类 FSDK.Path 来表示墨迹列表数据， 但路径对象的点类型已经为墨迹列表进行了特别简化。 墨迹列表中的点仅使用 FSDK.Path.e_TypeMoveTo 和 FSDK.Path.e_TypeLineTo 类型：

- 类型为 FSDK.Path.e_TypeMoveTo 的点表示此点是笔画路径的起始点。 通常路径对象中的第一个点应该是此类型。
- 类型为 FSDK.Path.e_TypeLineTo 的点表示此点在笔画路径中， 该路径由类型为 FSDK.Path.e_TypeMoveTo 的点开始， 当调用函数 FSDK.Annot.ResetAppearanceStream（从 Ink 的父类继承）时， Foxit PDF SDK 将通过曲线将此点与其他点连接。

诸如移动墨迹注释或为此注释设置新的墨迹路径等操作将更新墨迹路径数据， 从而使先前返回的路径对象变为无效。在这种情况下，用户应再次调用此函数以获取新的路径对象。

返回
  墨迹列表数据。如果返回的路径对象的函数 FSDK.Path.IsEmpty 的返回值为 true，则表示找不到墨迹列表数据。

## ◆ SetInkList()

FSDK::Ink::SetInkList | ( | ink_list |  | ) |

设置墨迹列表数据。

墨迹列表属性对于墨迹注释是必需的，此属性会影响墨迹注释的外观。 墨迹列表包含一个或多个笔画路径。
在 Foxit PDF SDK 中，使用类 FSDK.Path 来表示墨迹列表数据， 但路径对象的点类型已经为墨迹列表进行了特别简化。 墨迹列表中的点仅使用 FSDK.Path.e_TypeMoveTo 和 FSDK.Path.e_TypeLineTo 类型：

- 类型为 FSDK.Path.e_TypeMoveTo 的点表示此点是笔画路径的起始点。 通常路径对象中的第一个点应该是此类型。
- 类型为 FSDK.Path.e_TypeLineTo 的点表示此点在笔画路径中， 该路径由类型为 FSDK.Path.e_TypeMoveTo 的点开始， 当调用函数 FSDK.Annot.ResetAppearanceStream（从 Ink 的父类继承）时， Foxit PDF SDK 将通过曲线将此点与其他点连接。

特别地，如果输入参数 ink_list 包含贝塞尔点（例如，通过函数 FSDK.Path.CubicBezierTo 添加），控制点将被忽略，仅使用目标点在墨迹列表数据中。
强烈建议用户仅使用点类型 FSDK.Path.e_TypeMoveTo 和 FSDK.Path.e_TypeLineTo 传递有效的路径对象。
如果用户希望此效果显示在注释的外观中，请在此函数后调用函数 FSDK.Annot.ResetAppearanceStream。

参数

  [in] | ink_list | 指定新列表数据的新路径对象。

返回
  None.