Foxit PDF SDK

Public 类型 | Public 成员函数 | 所有成员列表
foxit::pdf::annots::Markup类 参考
类 foxit::pdf::annots::Markup 继承关系图:

## Public 类型
enum | EndingStyle { e_EndingStyleNone = 0, e_EndingStyleSquare = 1, e_EndingStyleCircle = 2, e_EndingStyleDiamond = 3, e_EndingStyleOpenArrow = 4, e_EndingStyleClosedArrow = 5, e_EndingStyleButt = 6, e_EndingStyleROpenArrow = 7, e_EndingStyleRClosedArrow = 8, e_EndingStyleSlash = 9 }
| 线条端点样式的枚举。 更多...
enum | MeasureType { e_MeasureTypeX = 0, e_MeasureTypeY = 1, e_MeasureTypeD = 2, e_MeasureTypeA = 3, e_MeasureTypeT = 4, e_MeasureTypeS = 5 }
| 注释测量类型的枚举。 更多...
enum | State { e_StateNone = 0, e_StateMarked = 1, e_StateUnmarked = 2, e_StateAccepted = 3, e_StateRejected = 4, e_StateCancelled = 5, e_StateCompleted = 6, e_StateDeferred = 7, e_StateFuture = 8 }
| 标记注释状态的枚举。 更多...
enum | StateModel { e_StateModelMarked = 1, e_StateModelReview = 2 }
| 标记注释状态模型的枚举。 更多...
Public 类型 继承自 foxit::pdf::annots::Annot
enum | AppearanceType { e_AppearanceTypeNormal = 0, e_AppearanceTypeRollover = 1, e_AppearanceTypeDown = 2 }
| 注释外观类型的枚举。 更多...
enum | Flags { e_FlagInvisible = 0x0001, e_FlagHidden = 0x0002, e_FlagPrint = 0x0004, e_FlagNoZoom = 0x0008, e_FlagNoRotate = 0x0010, e_FlagNoView = 0x0020, e_FlagReadOnly = 0x0040, e_FlagLocked = 0x0080, e_FlagToggleNoView = 0x0100, e_FlagLockedContents = 0x0200 }
| PDF注释标志的枚举。 更多...
enum | HighlightingMode { e_HighlightingNone = 0, e_HighlightingInvert = 1, e_HighlightingOutline = 2, e_HighlightingPush = 3, e_HighlightingToggle = 4 }
| PDF注释高亮模式的枚举。 更多...
enum | MKEntry { e_MKEntryRotation = 0, e_MKEntryBorderColor = 1, e_MKEntryBackgroundColor = 2, e_MKEntryNormalCaption = 3, e_MKEntryRolloverCaption = 4, e_MKEntryDownCaption = 5, e_MKEntryNormalIcon = 6, e_MKEntryRolloverIcon = 7, e_MKEntryDownIcon = 8, e_MKEntryIconFit = 9, e_MKEntryIconCaptionRelation = 10 }
| 注释MK字典（外观特征）条目的枚举。 更多...
enum | MKIconCaptionRelation { e_MKRelationNoIcon = 0, e_MKRelationNoCaption = 1, e_MKRelationCaptionBelowIcon = 2, e_MKRelationCaptionAboveIcon = 3, e_MKRelationCaptionRight = 4, e_MKRelationCaptionLeft = 5, e_MKRelationCaptionOvrlayOnIcon = 6 }
| 注释MK字典中图标和标题相对位置的枚举。 更多...
enum | Property { e_PropertyModifiedDate = 0, e_PropertyCreationDate = 1, e_PropertyBorderColor = 2, e_PropertyFillColor = 3 }
| 某些PDF注释属性的枚举。 更多...
enum | Type { e_UnknownType = 0, e_Note = 1, e_Link = 2, e_FreeText = 3, e_Line = 4, e_Square = 5, e_Circle = 6, e_Polygon = 7, e_PolyLine = 8, e_Highlight = 9, e_Underline = 10, e_Squiggly = 11, e_StrikeOut = 12, e_Stamp = 13, e_Caret = 14, e_Ink = 15, e_PSInk = 16, e_FileAttachment = 17, e_Sound = 18, e_Movie = 19, e_Widget = 20, e_Screen = 21, e_PrinterMark = 22, e_TrapNet = 23, e_Watermark = 24, e_3D = 25, e_Popup = 26, e_Redact = 27, e_RichMedia = 28, e_PagingSeal = 29 }
| PDF注释类型的枚举。 更多...

## Public 成员函数
| Markup ()
| 构造函数
| Markup (const Annot &annot)
| 构造函数，使用父类对象。 更多...
| ~Markup ()
| 析构函数。
Note | AddReply ()
| 在回复列表的末尾添加新回复。 更多...
void | AddRichText (const WString &content, const RichTextStyle &style)
| 在末尾添加新的富文本字符串。 更多...
Note | AddStateAnnot (const WString &title, StateModel model, State state)
| 添加新的状态注释。 更多...
float | GetBorderOpacity () const
| 获取注释的边框透明度。 更多...
DateTime | GetCreationDateTime () const
| 获取创建日期时间。 更多...
float | GetFillOpacity () const
| 获取注释的填充透明度。 更多...
MarkupArray | GetGroupElements ()
| 从当前标记注释所属的组中获取一个元素（作为标记注释）。 更多...
Markup | GetGroupHeader ()
| 获取当前标记注释所属组的头注释（作为主注释）。 更多...
String | GetIntent () const
| 获取意图名称。 更多...
float | GetOpacity () const
| 获取不透明度值。 更多...
Popup | GetPopup ()
| 获取相关的弹出注释。 更多...
Note | GetReply (int index) const
| 按索引获取回复。 更多...
int | GetReplyCount ()
| 计算所有回复。 更多...
WString | GetRichTextContent (int32 index)
| 获取指定索引的富文本字符串的文本字符串。 更多...
int32 | GetRichTextCount ()
| 获取富文本字符串的数量。 更多...
RichTextStyle | GetRichTextStyle (int32 index)
| 获取指定索引的富文本字符串的样式数据。 更多...
NoteArray | GetStateAnnots (StateModel model)
| 获取指定状态模型中的所有状态注释。 更多...
WString | GetSubject () const
| 获取主题字符串。 更多...
WString | GetTitle () const
| 获取标题字符串。 更多...
void | InsertRichText (int32 index, const WString &content, const RichTextStyle &style)
| 在指定索引位置插入新的富文本字符串。 更多...
bool | IsGrouped ()
| 检查当前标记注释是否在组中。 更多...
bool | RemoveAllReplies ()
| 删除所有回复。 更多...
bool | RemoveAllStateAnnots ()
| 移除所有状态注释。 更多...
bool | RemovePopup ()
| 删除相关的弹出注释。 更多...
bool | RemoveReply (int index)
| 按索引删除回复。 更多...
void | RemoveRichText (int index)
| 移除指定索引的富文本字符串。 更多...
void | SetBorderOpacity (float opacity)
| 设置注释的边框透明度。 更多...
void | SetCreationDateTime (const DateTime &date_time)
| 设置创建日期时间。 更多...
void | SetFillOpacity (float opacity)
| 设置注释的填充透明度。 更多...
void | SetIntent (const String &intent)
| 设置意图名称。 更多...
void | SetOpacity (float opacity)
| 设置不透明度值。 更多...
void | SetPopup (const Popup &popup)
| 设置相关的弹出注释。 更多...
void | SetRichTextContent (int32 index, const WString &content)
| 设置指定索引的富文本字符串的文本字符串。 更多...
void | SetRichTextStyle (int32 index, const RichTextStyle &style)
| 设置指定索引的富文本字符串的样式数据。 更多...
void | SetSubject (const WString &subject)
| 设置主题字符串。 更多...
void | SetTitle (const WString &title)
| 设置标题字符串。 更多...
bool | Ungroup ()
| 将当前标记注释从其所属的组中解组。 更多...
Public 成员函数 继承自 foxit::pdf::annots::Annot
| Annot ()
| 构造函数。
| Annot (const Annot &annot)
| 构造函数，使用另一个注释对象。 更多...
| Annot (const PDFPage &page, objects::PDFDictionary *annot_dict)
| 构造函数，使用PDF页面和注释的PDF字典。 更多...
virtual | ~Annot ()
| 析构函数。
objects::PDFStream * | GetAppearanceStream (AppearanceType type, const char *appearance_state="") const
| 获取具有指定类型和状态的注释外观流。 更多...
RGB | GetBorderColor () const
| 获取边框颜色。 更多...
BorderInfo | GetBorderInfo () const
| 获取边框信息。 更多...
WString | GetContent () const
| 获取内容。 更多...
RectI | GetDeviceRect (const Matrix &matrix)
| 获取设备坐标系统中的注释矩形。 更多...
objects::PDFDictionary * | GetDict () const
| 获取注释的字典对象。 更多...
Matrix | GetDisplayMatrix (const Matrix &page_display_matrix)
| 获取显示矩阵，从PDF坐标系统到 目标设备坐标系统。 更多...
uint32 | GetFlags () const
| 获取注释标志。 更多...
int | GetIndex () const
| 获取当前注释在其所属页面中的索引。 更多...
DateTime | GetModifiedDateTime () const
| 获取最后修改日期时间。 更多...
objects::PDFDictionary * | GetOptionalContent () const
| 获取注释可选内容的PDF字典。 更多...
PDFPage | GetPage () const
| 获取相关的PDF页面。 更多...
RectF | GetRect () const
| 获取矩形，以PDF坐标系统表示。 更多...
Type | GetType () const
| 获取当前注释的实际注释类型。 更多...
WString | GetUniqueID () const
| 获取唯一ID。 更多...
bool | HasProperty (Property property) const
| 当前注释是否具有指定的注释属性。 更多...
bool | IsEmpty () const
| 检查当前对象是否为空。 更多...
bool | IsMarkup () const
| 检查当前注释是否为标记注释。 更多...
bool | Move (const RectF &rect)
| 将当前注释移动到新位置，由PDF坐标系统中的新矩形指定。 更多...
bool | Move (const RectF &rect, bool is_reset_appearance)
| 将当前注释移动到新位置，由PDF坐标系统中的新矩形指定。 更多...
bool | operator!= (const Annot &other) const
| 不等于运算符。 更多...
Annot & | operator= (const Annot &annot)
| 赋值运算符。 更多...
bool | operator== (const Annot &other) const
| 等于运算符。 更多...
bool | RemoveProperty (Property property)
| 删除指定的注释属性。 更多...
bool | ResetAppearanceStream ()
| 重置外观流。 更多...
bool | ResetAppearanceStream (bool is_generate_new_appearance_obj)
| 重置外观流。 更多...
void | SetBorderColor (RGB color)
| 设置边框颜色。 更多...
void | SetBorderInfo (const BorderInfo &border)
| 设置边框信息。 更多...
void | SetContent (const WString &content)
| 设置内容。 更多...
void | SetFlags (uint32 flags)
| 设置注释标志。 更多...
void | SetModifiedDateTime (const DateTime &date_time)
| 设置最后修改日期时间。 更多...
void | SetUniqueID (const WString &unique_id)
| 设置唯一ID。 更多...
Public 成员函数 继承自 foxit::Base
FS_HANDLE | Handle () const
| 获取当前对象的句柄。 更多...

## 详细描述

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

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

参见
  Annot

## 成员枚举类型说明

## ◆ EndingStyle

enum foxit::pdf::annots::Markup::EndingStyle

线条端点样式的枚举。

此枚举的值应单独使用。

枚举值
e_EndingStyleNone | 无特殊线条端点。
e_EndingStyleSquare | 用注释的内部颜色填充的正方形（如果有）。
e_EndingStyleCircle | 用注释的内部颜色填充的圆形（如果有）。
e_EndingStyleDiamond | 用注释的内部颜色填充的菱形（如果有）。
e_EndingStyleOpenArrow | 两条短线以锐角相交形成开放箭头。
e_EndingStyleClosedArrow | 两条短线以锐角相交（如OpenArrow样式），并由第三条线连接， 形成用注释的内部颜色填充的三角形闭合箭头（如果有）。
e_EndingStyleButt | 端点处垂直于线条本身的短线。
e_EndingStyleROpenArrow | 与OpenArrow方向相反的两条短线。
e_EndingStyleRClosedArrow | 与ClosedArrow方向相反的三角形闭合箭头。
e_EndingStyleSlash | 端点处与线条垂直方向约顺时针30度的短线。

## ◆ MeasureType

enum foxit::pdf::annots::Markup::MeasureType

注释测量类型的枚举。

此枚举的值应单独使用。

枚举值
e_MeasureTypeX | 沿x轴变化的测量。
e_MeasureTypeY | 沿y轴变化的测量。
e_MeasureTypeD | 任意方向距离的测量。
e_MeasureTypeA | 面积的测量。
e_MeasureTypeT | 角度的测量。
e_MeasureTypeS | 直线斜率的测量。

## ◆ State

enum foxit::pdf::annots::Markup::State

标记注释状态的枚举。

此枚举的值应单独使用。

枚举值
e_StateNone | （与状态模型Markup::e_StateModelReview一起使用） 用户没有对更改表示任何意见。
e_StateMarked | （与状态模型Markup::e_StateModelMarked一起使用） 注释已被用户标记。
e_StateUnmarked | （与状态模型Markup::e_StateModelMarked一起使用） 注释尚未被用户标记。
e_StateAccepted | （与状态模型Markup::e_StateModelReview一起使用） 用户同意更改。
e_StateRejected | （与状态模型Markup::e_StateModelReview一起使用） 用户不同意更改。
e_StateCancelled | （与状态模型Markup::e_StateModelReview一起使用） 更改已被取消。
e_StateCompleted | （与状态模型Markup::e_StateModelReview一起使用） 更改已完成。
e_StateDeferred | （与状态模型Markup::e_StateModelReview一起使用） 更改已延期。
e_StateFuture | （与状态模型Markup::e_StateModelReview一起使用） 更改将在将来进行。

## ◆ StateModel

enum foxit::pdf::annots::Markup::StateModel

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

此枚举的值应单独使用。

枚举值
e_StateModelMarked | 标记注释状态模型：已标记。
e_StateModelReview | 标记注释状态模型：审阅。

## 构造及析构函数说明

## ◆ Markup()

foxit::pdf::annots::Markup::Markup | ( | const Annot & | annot | ) |
| explicit

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

参数

  [in] | annot | 父类对象。

## 成员函数说明

## ◆ AddReply()

Note foxit::pdf::annots::Markup::AddReply | ( |  | ) |

在回复列表的末尾添加新回复。

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

## ◆ AddRichText()

void foxit::pdf::annots::Markup::AddRichText | ( | const WString & | content,
|  | const RichTextStyle & | style
| ) |  |

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

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

参数

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

返回
  无。

## ◆ AddStateAnnot()

Note foxit::pdf::annots::Markup::AddStateAnnot | ( | const WString & | title,
|  | StateModel | model,
|  | State | state
| ) |  |

添加新的状态注释。

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

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

参数

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

返回
  表示新状态注释的注记注释。返回的状态注释的最后修改日期时间 默认情况下将设置为当前本地系统时间。

## ◆ GetBorderOpacity()

float foxit::pdf::annots::Markup::GetBorderOpacity | ( |  | ) | const

获取注释的边框透明度。

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

## ◆ GetCreationDateTime()

DateTime foxit::pdf::annots::Markup::GetCreationDateTime | ( |  | ) | const

获取创建日期时间。

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

## ◆ GetFillOpacity()

float foxit::pdf::annots::Markup::GetFillOpacity | ( |  | ) | const

获取注释的填充透明度。

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

## ◆ GetGroupElements()

MarkupArray foxit::pdf::annots::Markup::GetGroupElements | ( |  | ) |

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

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

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

## ◆ GetGroupHeader()

Markup foxit::pdf::annots::Markup::GetGroupHeader | ( |  | ) |

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

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

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

## ◆ GetIntent()

String foxit::pdf::annots::Markup::GetIntent | ( |  | ) | const

获取意图名称。

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

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

返回
  意图名称字符串。

## ◆ GetOpacity()

float foxit::pdf::annots::Markup::GetOpacity | ( |  | ) | const

获取不透明度值。

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

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

## ◆ GetPopup()

Popup foxit::pdf::annots::Markup::GetPopup | ( |  | ) |

获取相关的弹出注释。

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

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

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

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

## ◆ GetReply()

Note foxit::pdf::annots::Markup::GetReply | ( | int | index | ) | const

按索引获取回复。

参数

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

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

## ◆ GetReplyCount()

int foxit::pdf::annots::Markup::GetReplyCount | ( |  | ) |

计算所有回复。

返回
  回复的数量。

## ◆ GetRichTextContent()

WString foxit::pdf::annots::Markup::GetRichTextContent | ( | int32 | index | ) |

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

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

参数

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

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

## ◆ GetRichTextCount()

int32 foxit::pdf::annots::Markup::GetRichTextCount | ( |  | ) |

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

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

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

## ◆ GetRichTextStyle()

RichTextStyle foxit::pdf::annots::Markup::GetRichTextStyle | ( | int32 | index | ) |

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

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

参数

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

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

## ◆ GetStateAnnots()

NoteArray foxit::pdf::annots::Markup::GetStateAnnots | ( | StateModel | model | ) |

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

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

参数

  [in] | model | 状态模型。应为以下值之一： Markup::e_StateModelMarked Markup::e_StateModelReview

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

## ◆ GetSubject()

WString foxit::pdf::annots::Markup::GetSubject | ( |  | ) | const

获取主题字符串。

返回
  主题字符串。

## ◆ GetTitle()

WString foxit::pdf::annots::Markup::GetTitle | ( |  | ) | const

获取标题字符串。

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

返回
  标题字符串。

## ◆ InsertRichText()

void foxit::pdf::annots::Markup::InsertRichText | ( | int32 | index,
|  | const WString & | content,
|  | const RichTextStyle & | style
| ) |  |

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

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

参数

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

返回
  无。

## ◆ IsGrouped()

bool foxit::pdf::annots::Markup::IsGrouped | ( |  | ) |

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

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

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

## ◆ RemoveAllReplies()

bool foxit::pdf::annots::Markup::RemoveAllReplies | ( |  | ) |

删除所有回复。

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

## ◆ RemoveAllStateAnnots()

bool foxit::pdf::annots::Markup::RemoveAllStateAnnots | ( |  | ) |

移除所有状态注释。

状态注释由注记注释表示，因此移除状态注释意味着 从页面中移除此类注记注释（及其弹出注释，如果有的话）。

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

## ◆ RemovePopup()

bool foxit::pdf::annots::Markup::RemovePopup | ( |  | ) |

删除相关的弹出注释。

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

## ◆ RemoveReply()

bool foxit::pdf::annots::Markup::RemoveReply | ( | int | index | ) |

按索引删除回复。

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

参数

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

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

## ◆ RemoveRichText()

void foxit::pdf::annots::Markup::RemoveRichText | ( | int | index | ) |

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

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

参数

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

返回
  无。

## ◆ SetBorderOpacity()

void foxit::pdf::annots::Markup::SetBorderOpacity | ( | float | opacity | ) |

设置注释的边框透明度。

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

参数

  [in] | opacity | 新的透明度值。有效范围：0.0 到 1.0。 0.0 means full transparency and 1.0 means full opaque.

返回
  None.

## ◆ SetCreationDateTime()

void foxit::pdf::annots::Markup::SetCreationDateTime | ( | const DateTime & | date_time | ) |

设置创建日期时间。

参数

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

返回
  无。

## ◆ SetFillOpacity()

void foxit::pdf::annots::Markup::SetFillOpacity | ( | float | opacity | ) |

设置注释的填充透明度。

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

参数

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

返回
  无。

## ◆ SetIntent()

void foxit::pdf::annots::Markup::SetIntent | ( | const String & | intent | ) |

设置意图名称。

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

- 自由文本注释的预定义意图名称："FreeTextCallout"、"FreeTextTypewriter"。 如果未使用意图名称，自由文本注释将显示为文本框。 如果意图名称为 FreeTextTypewriter，边框颜色将被移除。
- 直线注释的预定义意图名称："LineArrow"、"LineDimension"。 如果未使用意图名称，直线注释将显示为普通直线。
  如果直线注释的意图设置为"LineArrow"，直线注释的线条结束样式 将默认为起点 Markup::e_EndingStyleNone 和 终点 Markup::e_EndingStyleOpenArrow。
- 多边形的预定义意图名称："PolygonCloud"、"PolygonDimension"。 如果未使用意图名称，多边形注释将显示为普通多边形。
  如果多边形注释的意图设置为"PolygonCloud"，多边形注释的 边框样式将更改为 BorderInfo::e_Cloudy， 边框云状强度将默认设置为 2。
- 折线注释的预定义意图名称："PolyLineDimension"。 如果未使用意图名称，折线注释将显示为普通折线。

如果已为相应类型的注释设置了支持的预定义意图名称，用户应调用 函数 Annot::ResetAppearanceStream 以在注释外观上产生效果。

参数

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

返回
  无。

## ◆ SetOpacity()

void foxit::pdf::annots::Markup::SetOpacity | ( | float | opacity | ) |

设置不透明度值。

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

参数

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

返回
  无。

## ◆ SetPopup()

void foxit::pdf::annots::Markup::SetPopup | ( | const Popup & | popup | ) |

设置相关的弹出注释。

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

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

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

参数

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

返回
  无。

## ◆ SetRichTextContent()

void foxit::pdf::annots::Markup::SetRichTextContent | ( | int32 | index,
|  | const WString & | content
| ) |  |

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

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

参数

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

返回
  无。

## ◆ SetRichTextStyle()

void foxit::pdf::annots::Markup::SetRichTextStyle | ( | int32 | index,
|  | const RichTextStyle & | style
| ) |  |

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

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

参数

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

返回
  无。

## ◆ SetSubject()

void foxit::pdf::annots::Markup::SetSubject | ( | const WString & | subject | ) |

设置主题字符串。

参数

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

返回
  无。

## ◆ SetTitle()

void foxit::pdf::annots::Markup::SetTitle | ( | const WString & | title | ) |

设置标题字符串。

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

参数

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

返回
  无。

## ◆ Ungroup()

bool foxit::pdf::annots::Markup::Ungroup | ( |  | ) |

将当前标记注释从其所属的组中解组。

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

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