Foxit PDF SDK

Public 成员函数 | 静态 Public 属性 | 所有成员列表
FSDK::Markup类 参考
类 FSDK::Markup 继承关系图:

## Public 成员函数
| 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 属性
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>中的标准注释之一。 更多...

## 详细描述

标记注释主要用于标记PDF文档。这些注释具有作为注释一部分出现的文本， 并且可以由查看器应用程序以其他方式显示，例如在注释面板中。
类 FSDK.Markup 派生自类 FSDK.Annot，也是所有PDF标记注释的基类。 它提供了获取/设置标记注释公共属性的基本功能。 对于具体的标记注释类型，请参阅派生类。
函数 FSDK.Annot.IsMarkup 可用于判断注释是否为标记注释。

注解
  目前，以下类型的功能仅支持注释、高亮、下划线、删除线、波浪线、 正方形、圆形、自由文本、图章、插入符、墨迹、直线、多边形、折线、文件附件注释：
  - 类 FSDK.Markup 中的所有"set"函数。
  - 函数 FSDK.Annot.ResetAppearanceStream（从 FSDK.Markup 的父类继承）。

参见
  FSDK.Annot

## 成员函数说明

## ◆ AddReply()

FSDK::Markup::AddReply | ( |  | ) |

将新回复添加到回复列表的末尾。

返回
  表示新回复注释的新注释注释。

## ◆ AddRichText()

FSDK::Markup::AddRichText | ( | content | ,
|  | style |
| ) |  |

将新的富文本字符串添加到末尾。

标记注释的内容可以由多个富文本字符串组成。 特别地，如果当前注释是自由文本且其意图是"FreeTextTypewriter"，则输入样式的文本对齐方式将 被设置到当前自由文本注释的所有富文本字符串。

参数

  [in] | content | 用作新富文本字符串内容的文本字符串。这不应该是空字符串。
  [in] | style | 用于新富文本字符串的样式数据。

返回
  无。

## ◆ AddStateAnnot()

FSDK::Markup::AddStateAnnot | ( | title | ,
|  | model | ,
|  | state |
| ) |  |

添加新的状态注释。

标记注释可能有一个或多个与之关联的特定于作者的状态。每个状态不是在 注释本身中指定，而是在单独的注释注释中指定。

- 对于状态模型FSDK.Markup.e_StateModelReview，此函数在每次调用时都会添加新的状态注释。
- 对于状态模型FSDK.Markup.e_StateModelMarked，此函数将查找具有此模型且 标题与输入参数title相同的最新状态注释：如果找到，此函数将更改找到的状态注释的状态值并 直接返回找到的状态注释；如果未找到任何合适的状态注释，此函数将添加一个新的并 返回新的状态注释。

参数

  [in] | title | 新状态注释的标题。标题可用于标识添加当前注释的用户。 这可以是空字符串，但强烈建议用户在使用此函数时设置有意义的标题。
  [in] | model | 新状态注释的状态模型。它应该是以下值之一： FSDK.Markup.e_StateModelMarked FSDK.Markup.e_StateModelReview
  [in] | state | 新状态注释的状态值。它应该是以下值之一： 如果参数model是FSDK.Markup.e_StateModelMarked， 状态应该是FSDK.Markup.e_StateMarked或FSDK.Markup.e_StateUnmarked。 如果参数model是FSDK.Markup.e_StateModelReview， 状态应该是FSDK.Markup.e_StateAccepted、FSDK.Markup.e_StateRejected、 FSDK.Markup.e_StateCancelled、FSDK.Markup.e_StateCompleted、 FSDK.Markup.e_StateDeferred、FSDK.Markup.e_StateFuture 或FSDK.Markup.e_StateNone。

返回
  表示新状态注释的注释注释。返回的状态注释的上次修改日期时间 默认设置为当前本地系统时间。

## ◆ constructor()

FSDK::Markup::constructor | ( | annot |  | ) |

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

参数

  [in] | annot | 父类对象。

## ◆ GetBorderOpacity()

FSDK::Markup::GetBorderOpacity | ( |  | ) |

获取注释的边框不透明度。

返回
  不透明度值。有效范围：0.0到1.0。 0.0表示完全透明，1.0表示完全不透明。

## ◆ GetCreationDateTime()

FSDK::Markup::GetCreationDateTime | ( |  | ) |

获取创建日期时间。

返回
  接收创建日期时间的日期和时间对象。 如果没有创建日期时间信息，将返回所有值为0的日期和时间对象。

## ◆ GetFillOpacity()

FSDK::Markup::GetFillOpacity | ( |  | ) |

获取注释的填充不透明度。

返回
  不透明度值。有效范围：0.0到1.0。 0.0表示完全透明，1.0表示完全不透明。

## ◆ GetGroupElements()

FSDK::Markup::GetGroupElements | ( |  | ) |

从当前标记注释所属的组中获取元素（作为标记注释）。

标记注释可以分组。该组由一个主注释和一个或多个 从属注释组成。主注释中的某些条目被视为组属性， 应适用于整个组；从属注释中的相应条目 应该被忽略。这些条目包括内容、上次修改时间、填充颜色/边框颜色、 标题、弹出注释、创建时间、主题和打开状态。因此用户应遵守 组属性：当更改组中注释的属性时，同一组中的其他注释 也应该更改。
查看器应用程序应将操作组中任何注释的操作（如移动、剪切和复制）视为 作用于整个组。

返回
  包含组中所有标记注释的数组。 如果当前注释不属于组，此函数将返回空数组。

## ◆ GetGroupHeader()

FSDK::Markup::GetGroupHeader | ( |  | ) |

获取当前标记注释所属组的标头注释（作为主注释）。

标记注释可以分组。该组由一个主注释和一个或多个 从属注释组成。主注释中的某些条目被视为组属性， 应适用于整个组；从属注释中的相应条目 应该被忽略。这些条目包括内容、上次修改时间、填充颜色/边框颜色、 标题、弹出注释、创建时间、主题和打开状态。因此用户应遵守 组属性：当更改组中注释的属性时，同一组中的其他注释 也应该更改。
查看器应用程序应将操作组中任何注释的操作（如移动、剪切和复制）视为 作用于整个组。

返回
  当前标记注释所属组的标头标记注释。 如果返回的标记注释对象的函数 FSDK.Annot.IsEmpty（从Markup的父类继承） 的返回值为true， 则表示当前注释不属于组。

## ◆ GetIntent()

FSDK::Markup::GetIntent | ( |  | ) |

获取意图名称。

以下注释类型具有预定义的意图名称：

- 自由文本注释的预定义意图名称："FreeTextCallout"、"FreeTextTypewriter"。 如果不使用意图名称，自由文本注释将显示为文本框。
- 直线注释的预定义意图名称："LineArrow"、"LineDimension"。 如果不使用意图名称，直线注释将显示为普通直线。
- 多边形的预定义意图名称："PolygonCloud"、"PolygonDimension"。 如果不使用意图名称，多边形注释将显示为普通多边形。
- 折线注释的预定义意图名称："PolyLineDimension"。 如果不使用意图名称，折线注释将显示为普通折线。

返回
  意图名称字符串。

## ◆ GetOpacity()

FSDK::Markup::GetOpacity | ( |  | ) |

获取不透明度值。

此属性对标记注释的外观有影响。

返回
  不透明度值。有效范围：0.0到1.0。 0.0表示完全透明，1.0表示完全不透明。

## ◆ GetPopup()

FSDK::Markup::GetPopup | ( |  | ) |

获取相关的弹出注释。

大多数标记注释可以有弹出注释来显示其内容，除了声音和自由文本 注释：

- 对于声音注释，它没有弹出注释。
- 对于自由文本注释，它直接在页面上显示文本，因此不需要弹出注释。

不过，在某些特殊（或错误）的PDF文档中，声音或自由文本注释可能有 弹出注释，但它们仍然不需要弹出注释。

返回
  相关的弹出注释。如果返回的弹出注释的函数 FSDK.Annot.IsEmpty （从 FSDK.Popup 的父类继承）的返回值为true， 那么表示当前标记注释没有弹出注释。

## ◆ GetReply()

FSDK::Markup::GetReply | ( | index |  | ) |

根据索引获取回复。

参数

  [in] | index | 指定回复的索引。有效范围：从0到(count-1)。 count由函数 FSDK.Markup.GetReplyCount 返回。

返回
  表示指定回复注释的注释注释。

## ◆ GetReplyCount()

FSDK::Markup::GetReplyCount | ( |  | ) |

计算所有回复的数量。

返回
  回复的数量。

## ◆ GetRichTextContent()

FSDK::Markup::GetRichTextContent | ( | index |  | ) |

获取由索引指定的富文本字符串的文本字符串。

标记注释的内容可以由多个富文本字符串组成。

参数

  [in] | index | 要检索内容的富文本字符串的索引。有效范围：从0到(count-1)。 count由函数FSDK.Markup.GetRichTextCount返回。

返回
  指定富文本的文本字符串。

## ◆ GetRichTextCount()

FSDK::Markup::GetRichTextCount | ( |  | ) |

获取富文本字符串的数量。

标记注释的内容可以由多个富文本字符串组成。

返回
  富文本字符串的数量。

## ◆ GetRichTextStyle()

FSDK::Markup::GetRichTextStyle | ( | index |  | ) |

获取由索引指定的富文本字符串的样式数据。

标记注释的内容可以由多个富文本字符串组成。

参数

  [in] | index | 要检索样式数据的富文本字符串的索引。有效范围：从0到(count-1)。 count由函数FSDK.Markup.GetRichTextCount返回。

返回
  指定富文本字符串的样式数据。

## ◆ GetStateAnnots()

FSDK::Markup::GetStateAnnots | ( | model |  | ) |

获取指定状态模型中的所有状态注释。

标记注释可能有一个或多个与之关联的特定于作者的状态。每个状态不是在 注释本身中指定，而是在单独的注释注释中指定。

参数

  [in] | model | 状态模型。它应该是以下值之一： FSDK.Markup.e_StateModelMarked FSDK.Markup.e_StateModelReview

返回
  表示指定状态模型中所有状态注释的注释注释数组。 此数组中的所有注释将按时间顺序排列。

## ◆ GetSubject()

FSDK::Markup::GetSubject | ( |  | ) |

获取主题字符串。

返回
  主题字符串。

## ◆ GetTitle()

FSDK::Markup::GetTitle | ( |  | ) |

获取标题字符串。

按惯例，注释的标题可用于标识添加当前注释的用户。

返回
  标题字符串。

## ◆ InsertRichText()

FSDK::Markup::InsertRichText | ( | index | ,
|  | content | ,
|  | style |
| ) |  |

将新的富文本字符串插入到由索引指定的位置。

标记注释的内容可以由多个富文本字符串组成。 特别地，如果当前注释是自由文本且其意图是"FreeTextTypewriter"，则输入样式的文本对齐方式将 被设置到当前自由文本注释的所有富文本字符串。

参数

  [in] | index | 要在其处插入样式数据的富文本字符串的索引。有效范围：从0到count。 count由函数FSDK.Markup.GetRichTextCount返回。 如果输入值等于富文本字符串计数，则表示将新富文本字符串添加到末尾。 在这种情况下，此函数等同于函数FSDK.Markup.AddRichText。
  [in] | content | 用作新富文本字符串内容的文本字符串。这不应该是空字符串。
  [in] | style | 用于新富文本字符串的样式数据。

返回
  无。

## ◆ IsGrouped()

FSDK::Markup::IsGrouped | ( |  | ) |

检查当前标记注释是否在组中。

标记注释可以分组。该组由一个主注释和一个或多个 从属注释组成。主注释中的某些条目被视为组属性， 应适用于整个组；从属注释中的相应条目 应该被忽略。这些条目包括内容、上次修改时间、填充颜色/边框颜色、 标题、弹出注释、创建时间、主题和打开状态。因此用户应遵守 组属性：当更改组中注释的属性时，同一组中的其他注释 也应该更改。
查看器应用程序应将操作组中任何注释的操作（如移动、剪切和复制）视为 作用于整个组。

返回
  true表示当前标记注释在组中。 false表示当前标记注释不属于任何组。

## ◆ RemoveAllReplies()

FSDK::Markup::RemoveAllReplies | ( |  | ) |

删除所有回复。

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

## ◆ RemoveAllStateAnnots()

FSDK::Markup::RemoveAllStateAnnots | ( |  | ) |

删除所有状态注释。

状态注释由注释注释表示，因此，删除状态注释意味着 从页面中删除此类注释注释（以及它们的弹出注释，如果有）。

返回
  true表示成功删除所有状态注释或当前注释没有任何 状态注释，而false表示失败。

## ◆ RemovePopup()

FSDK::Markup::RemovePopup | ( |  | ) |

移除相关的弹出注释。

返回
  true表示相关的弹出注释被成功移除， 而false表示当前标记注释没有相关的弹出注释。

## ◆ RemoveReply()

FSDK::Markup::RemoveReply | ( | index |  | ) |

根据索引删除回复。

如果指定的回复有自己的回复，这些子回复将同时被删除。

参数

  [in] | index | 要删除的指定回复的索引。有效范围：从0到(count-1)。 count由函数 FSDK.Markup.GetReplyCount 返回。

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

## ◆ RemoveRichText()

FSDK::Markup::RemoveRichText | ( | index |  | ) |

删除由索引指定的富文本字符串。

标记注释的内容可以由多个富文本字符串组成。

参数

  [in] | index | 要在其处插入样式数据的富文本字符串的索引。有效范围：从0到(count-1)。 count由函数FSDK.Markup.GetRichTextCount返回。

返回
  无。

## ◆ SetBorderOpacity()

FSDK::Markup::SetBorderOpacity | ( | opacity |  | ) |

设置注释的边框不透明度。

此属性对标记注释的外观有影响。如果用户希望新的不透明度值对 注释的外观产生影响，请在 设置新的不透明度值后调用函数FSDK.Annot.ResetAppearanceStream。

参数

  [in] | opacity | 新的不透明度值。有效范围：0.0到1.0。 0.0表示完全透明，1.0表示完全不透明。

返回
  无。

## ◆ SetCreationDateTime()

FSDK::Markup::SetCreationDateTime | ( | date_time |  | ) |

设置创建日期时间。

参数

  [in] | date_time | 要设置的新日期时间。

返回
  无。

## ◆ SetFillOpacity()

FSDK::Markup::SetFillOpacity | ( | opacity |  | ) |

设置注释的填充不透明度。

此属性对标记注释的外观有影响。如果用户希望新的不透明度值对 注释的外观产生影响，请在 设置新的不透明度值后调用函数FSDK.Annot.ResetAppearanceStream。

参数

  [in] | opacity | 新的不透明度值。有效范围：0.0到1.0。 0.0表示完全透明，1.0表示完全不透明。

返回
  无。

## ◆ SetIntent()

FSDK::Markup::SetIntent | ( | intent |  | ) |

设置意图名称。

以下注释类型具有预定义的意图名称：

- 自由文本注释的预定义意图名称："FreeTextCallout"、"FreeTextTypewriter"。 如果不使用意图名称，自由文本注释将显示为文本框。
- 直线注释的预定义意图名称："LineArrow"、"LineDimension"。 如果不使用意图名称，直线注释将显示为普通直线。
  如果直线注释的意图要设置为"LineArrow"，则直线注释的线条结束样式 默认情况下起点为 FSDK.Markup.e_EndingStyleNone， 终点为 FSDK.Markup.e_EndingStyleOpenArrow。
- 多边形的预定义意图名称："PolygonCloud"、"PolygonDimension"。 如果不使用意图名称，多边形注释将显示为普通多边形。
  如果多边形注释的意图要设置为"PolygonCloud"，则多边形注释的 边框样式将更改为 FSDK.BorderInfo.e_Cloudy， 边框云形强度默认设置为2。
- 折线注释的预定义意图名称："PolyLineDimension"。 如果不使用意图名称，折线注释将显示为普通折线。

如果已将支持的预定义意图名称设置为相应类型的注释，用户应调用 函数 FSDK.Annot.ResetAppearanceStream 以使其对注释外观生效。

参数

  [in] | intent | 要设置的新意图名称字符串。如果是空字符串，则意味着不使用意图属性。 某些注释类型具有预定义的意图名称，请参阅"Details"部分 了解更多详细信息。如果此字符串是不支持的意图名称之一， 则在设置为相应注释时将忽略此字符串。

返回
  无。

## ◆ SetOpacity()

FSDK::Markup::SetOpacity | ( | opacity |  | ) |

设置不透明度值。

此属性对标记注释的外观有影响。如果用户希望新的不透明度值对 注释的外观产生影响，请在设置新的不透明度值后调用函数 FSDK.Annot.ResetAppearanceStream。

参数

  [in] | opacity | 新的不透明度值。有效范围：0.0到1.0。 0.0表示完全透明，1.0表示完全不透明。

返回
  无。

## ◆ SetPopup()

FSDK::Markup::SetPopup | ( | popup |  | ) |

设置相关的弹出注释。

大多数标记注释可以有弹出注释来显示其内容，除了声音和自由文本 注释：

- 对于声音注释，它没有弹出注释。
- 对于自由文本注释，它直接在页面上显示文本，因此不需要弹出注释。

因此，此函数不允许将弹出注释设置为声音和自由文本注释。

参数

  [in] | popup | 要设置为当前标记注释的有效弹出注释。

返回
  无。

## ◆ SetRichTextContent()

FSDK::Markup::SetRichTextContent | ( | index | ,
|  | content |
| ) |  |

设置由索引指定的富文本字符串的文本字符串。

标记注释的内容可以由多个富文本字符串组成。

参数

  [in] | index | 要设置内容的富文本字符串的索引。有效范围：从0到(count-1)。 count由函数FSDK.Markup.GetRichTextCount返回。
  [in] | content | 要设置为指定富文本内容的文本字符串。这不应该是空字符串。

返回
  无。

## ◆ SetRichTextStyle()

FSDK::Markup::SetRichTextStyle | ( | index | ,
|  | style |
| ) |  |

设置由索引指定的富文本字符串的样式数据。

标记注释的内容可以由多个富文本字符串组成。
特别地，如果当前注释是自由文本且其意图是"FreeTextTypewriter"，则输入样式的文本对齐方式将 被设置到当前自由文本注释的所有富文本字符串。

参数

  [in] | index | 要检索样式数据的富文本字符串的索引。有效范围：从0到(count-1)。 count由函数FSDK.Markup.GetRichTextCount返回。
  [in] | style | 用于设置到指定富文本的样式数据。

返回
  无。

## ◆ SetSubject()

FSDK::Markup::SetSubject | ( | subject |  | ) |

设置主题字符串。

参数

  [in] | subject | 要设置的新主题字符串。

返回
  无。

## ◆ SetTitle()

FSDK::Markup::SetTitle | ( | title |  | ) |

设置标题字符串。

按惯例，注释的标题可用于标识添加当前注释的用户。

参数

  [in] | title | 要设置的新标题字符串。

返回
  无。

## ◆ Ungroup()

FSDK::Markup::Ungroup | ( |  | ) |

将当前标记注释从其所属的组中取消分组。

- 如果当前标记注释只是组标头，则此函数将 解散整个组。
- 如果当前标记注释只是组的成员，则此函数只会 将当前标记注释从其所属的组中取消分组。
- 如果当前标记注释不属于任何组，则此函数将不执行任何操作并 直接返回false。

返回
  true表示成功，而false表示当前标记注释不属于 任何组。

## 类成员变量说明

## ◆ e_EndingStyleNone

FSDK::Markup::e_EndingStyleNone
| static

线条结束样式的枚举。

此枚举的值应单独使用。

无特殊线条结束。

## ◆ e_MeasureTypeX

FSDK::Markup::e_MeasureTypeX
| static

注释度量类型的枚举。

此枚举的值应单独使用。

沿 x轴变化的测量。

## ◆ e_StateModelMarked

FSDK::Markup::e_StateModelMarked
| static

标记注释状态模型的枚举。

此枚举的值应单独使用。

标记注释状态模型：标记。

## ◆ e_StateNone

FSDK::Markup::e_StateNone
| static

标记注释状态的枚举。

此枚举的值应单独使用。

（与状态模型 FSDK.Markup.e_StateModelReview 一起使用） 用户没有对更改表示任何意见。