Foxit PDF SDK

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

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

## 静态 Public 属性
| e_EndingStyleButt = _fsdk.Markup_e_EndingStyleButt
| 端点处垂直于线条本身的短线。
| e_EndingStyleCircle = _fsdk.Markup_e_EndingStyleCircle
| 用注释的内部颜色填充的圆形（如果有）。
| e_EndingStyleClosedArrow = _fsdk.Markup_e_EndingStyleClosedArrow
| 两条短线以锐角相交（如OpenArrow样式），并由第三条线连接， 形成用注释的内部颜色填充的三角形闭合箭头（如果有）。
| e_EndingStyleDiamond = _fsdk.Markup_e_EndingStyleDiamond
| 用注释的内部颜色填充的菱形（如果有）。
| e_EndingStyleNone = _fsdk.Markup_e_EndingStyleNone
| 无特殊线条端点。
| e_EndingStyleOpenArrow = _fsdk.Markup_e_EndingStyleOpenArrow
| 两条短线以锐角相交形成开放箭头。
| e_EndingStyleRClosedArrow = _fsdk.Markup_e_EndingStyleRClosedArrow
| 与ClosedArrow方向相反的三角形闭合箭头。
| e_EndingStyleROpenArrow = _fsdk.Markup_e_EndingStyleROpenArrow
| 与OpenArrow方向相反的两条短线。
| e_EndingStyleSlash = _fsdk.Markup_e_EndingStyleSlash
| 端点处与线条垂直方向约顺时针30度的短线。
| e_EndingStyleSquare = _fsdk.Markup_e_EndingStyleSquare
| 用注释的内部颜色填充的正方形（如果有）。
| e_MeasureTypeA = _fsdk.Markup_e_MeasureTypeA
| 面积的测量。
| e_MeasureTypeD = _fsdk.Markup_e_MeasureTypeD
| 任意方向距离的测量。
| e_MeasureTypeS = _fsdk.Markup_e_MeasureTypeS
| 直线斜率的测量。
| e_MeasureTypeT = _fsdk.Markup_e_MeasureTypeT
| 角度的测量。
| e_MeasureTypeX = _fsdk.Markup_e_MeasureTypeX
| 沿x轴变化的测量。
| e_MeasureTypeY = _fsdk.Markup_e_MeasureTypeY
| 沿y轴变化的测量。
| e_StateAccepted = _fsdk.Markup_e_StateAccepted
| （与状态模型FoxitPDFSDKPython2.Markup.e_StateModelReview 一起使用） 用户同意更改。
| e_StateCancelled = _fsdk.Markup_e_StateCancelled
| （与状态模型FoxitPDFSDKPython2.Markup.e_StateModelReview 一起使用） 更改已被取消。
| e_StateCompleted = _fsdk.Markup_e_StateCompleted
| （与状态模型FoxitPDFSDKPython2.Markup.e_StateModelReview 一起使用） 更改已完成。
| e_StateDeferred = _fsdk.Markup_e_StateDeferred
| （与状态模型FoxitPDFSDKPython2.Markup.e_StateModelReview 一起使用） 更改已延期。
| e_StateFuture = _fsdk.Markup_e_StateFuture
| （与状态模型FoxitPDFSDKPython2.Markup.e_StateModelReview 一起使用） 更改将在将来进行。
| e_StateMarked = _fsdk.Markup_e_StateMarked
| （与状态模型FoxitPDFSDKPython2.Markup.e_StateModelMarked 一起使用） 注释已被用户标记。
| e_StateModelMarked = _fsdk.Markup_e_StateModelMarked
| 标记注释状态模型：已标记。
| e_StateModelReview = _fsdk.Markup_e_StateModelReview
| 标记注释状态模型：审阅。
| e_StateNone = _fsdk.Markup_e_StateNone
| （与状态模型FoxitPDFSDKPython2.Markup.e_StateModelReview 一起使用） 用户没有对更改表示任何意见。
| e_StateRejected = _fsdk.Markup_e_StateRejected
| （与状态模型FoxitPDFSDKPython2.Markup.e_StateModelReview 一起使用） 用户不同意更改。
| e_StateUnmarked = _fsdk.Markup_e_StateUnmarked
| （与状态模型FoxitPDFSDKPython2.Markup.e_StateModelMarked 一起使用） 注释尚未被用户标记。
静态 Public 属性 继承自 FoxitPDFSDKPython2.Annot
| e_3D = _fsdk.Annot_e_3D
| 注释类型：3D注释。<PDF参考1.7>中的标准注释之一。
| e_AppearanceTypeDown = _fsdk.Annot_e_AppearanceTypeDown
| 注释的按下外观。
| e_AppearanceTypeNormal = _fsdk.Annot_e_AppearanceTypeNormal
| 注释的正常外观。
| e_AppearanceTypeRollover = _fsdk.Annot_e_AppearanceTypeRollover
| 注释的悬停外观。
| e_Caret = _fsdk.Annot_e_Caret
| 注释类型：插入符注释。<PDF参考1.7>中的标准注释之一。
| e_Circle = _fsdk.Annot_e_Circle
| 注释类型：圆形注释。<PDF参考1.7>中的标准注释之一。
| e_FileAttachment = _fsdk.Annot_e_FileAttachment
| 注释类型：文件附件注释。<PDF参考1.7>中的标准注释之一。
| e_FlagHidden = _fsdk.Annot_e_FlagHidden
| 注释标志：隐藏。 更多...
| e_FlagInvisible = _fsdk.Annot_e_FlagInvisible
| 注释标志：不可见。 更多...
| e_FlagLocked = _fsdk.Annot_e_FlagLocked
| 注释标志：锁定。 更多...
| e_FlagLockedContents = _fsdk.Annot_e_FlagLockedContents
| 注释标志：锁定内容。 更多...
| e_FlagNoRotate = _fsdk.Annot_e_FlagNoRotate
| 注释标志：无旋转。 更多...
| e_FlagNoView = _fsdk.Annot_e_FlagNoView
| 注释标志：无视图。 更多...
| e_FlagNoZoom = _fsdk.Annot_e_FlagNoZoom
| 注释标志：无缩放。 更多...
| e_FlagPrint = _fsdk.Annot_e_FlagPrint
| 注释标志：打印。 更多...
| e_FlagReadOnly = _fsdk.Annot_e_FlagReadOnly
| 注释标志：只读。 更多...
| e_FlagToggleNoView = _fsdk.Annot_e_FlagToggleNoView
| 注释标志：切换无视图。 更多...
| e_FreeText = _fsdk.Annot_e_FreeText
| 注释类型：自由文本注释。<PDF参考1.7>中的标准注释之一。
| e_Highlight = _fsdk.Annot_e_Highlight
| 注释类型：高亮注释。<PDF参考1.7>中的标准注释之一。
| e_HighlightingInvert = _fsdk.Annot_e_HighlightingInvert
| 高亮模式：反转，即反转注释矩形的内容。
| e_HighlightingNone = _fsdk.Annot_e_HighlightingNone
| 高亮模式：无高亮。
| e_HighlightingOutline = _fsdk.Annot_e_HighlightingOutline
| 高亮模式：轮廓，即反转注释的边框。
| e_HighlightingPush = _fsdk.Annot_e_HighlightingPush
| 高亮模式：按下，即显示注释的按下外观（如果有）。
| e_HighlightingToggle = _fsdk.Annot_e_HighlightingToggle
| 高亮模式：切换。这仅对小组件注释有用。
| e_Ink = _fsdk.Annot_e_Ink
| 注释类型：墨迹注释。<PDF参考1.7>中的标准注释之一。
| e_Line = _fsdk.Annot_e_Line
| 注释类型：直线注释。<PDF参考1.7>中的标准注释之一。
| e_Link = _fsdk.Annot_e_Link
| 注释类型：链接注释。<PDF参考1.7>中的标准注释之一。
| e_MKEntryBackgroundColor = _fsdk.Annot_e_MKEntryBackgroundColor
| 背景颜色条目。MK字典中的"BG"。
| e_MKEntryBorderColor = _fsdk.Annot_e_MKEntryBorderColor
| 边框颜色条目。MK字典中的"BC"。
| e_MKEntryDownCaption = _fsdk.Annot_e_MKEntryDownCaption
| 按下标题（或备用标题）条目。MK字典中的"AC"。 更多...
| e_MKEntryDownIcon = _fsdk.Annot_e_MKEntryDownIcon
| 按下图标（或备用图标）条目。MK字典中的"IX"。 更多...
| e_MKEntryIconCaptionRelation = _fsdk.Annot_e_MKEntryIconCaptionRelation
| 图标和标题关系条目。MK字典中的"TP"。 更多...
| e_MKEntryIconFit = _fsdk.Annot_e_MKEntryIconFit
| 图标适配信息条目。MK字典中的"IF"。 更多...
| e_MKEntryNormalCaption = _fsdk.Annot_e_MKEntryNormalCaption
| 正常标题条目。MK字典中的"CA"。 更多...
| e_MKEntryNormalIcon = _fsdk.Annot_e_MKEntryNormalIcon
| 正常图标条目。MK字典中的"I"。 更多...
| e_MKEntryRolloverCaption = _fsdk.Annot_e_MKEntryRolloverCaption
| 悬停标题条目。MK字典中的"RC"。 更多...
| e_MKEntryRolloverIcon = _fsdk.Annot_e_MKEntryRolloverIcon
| 悬停图标条目。MK字典中的"RI"。 更多...
| e_MKEntryRotation = _fsdk.Annot_e_MKEntryRotation
| 旋转条目。MK字典中的"R"。
| e_MKRelationCaptionAboveIcon = _fsdk.Annot_e_MKRelationCaptionAboveIcon
| 标题在图标上方。
| e_MKRelationCaptionBelowIcon = _fsdk.Annot_e_MKRelationCaptionBelowIcon
| 标题在图标下方。
| e_MKRelationCaptionLeft = _fsdk.Annot_e_MKRelationCaptionLeft
| 标题在图标左侧。
| e_MKRelationCaptionOvrlayOnIcon = _fsdk.Annot_e_MKRelationCaptionOvrlayOnIcon
| 标题直接覆盖在图标上。
| e_MKRelationCaptionRight = _fsdk.Annot_e_MKRelationCaptionRight
| 标题在图标右侧。
| e_MKRelationNoCaption = _fsdk.Annot_e_MKRelationNoCaption
| 无标题；仅图标。
| e_MKRelationNoIcon = _fsdk.Annot_e_MKRelationNoIcon
| 无图标；仅标题。
| e_Movie = _fsdk.Annot_e_Movie
| 注释类型：电影注释。<PDF参考1.7>中的标准注释之一。
| e_Note = _fsdk.Annot_e_Note
| 注释类型：注记注释，即"文本"注释 - <PDF参考1.7>中的标准注释之一。
| e_PagingSeal = _fsdk.Annot_e_PagingSeal
| 注释类型：分页印章注释。福昕PDF SDK自定义注释类型（非标准注释类型）。
| e_Polygon = _fsdk.Annot_e_Polygon
| 注释类型：多边形注释。<PDF参考1.7>中的标准注释之一。
| e_PolyLine = _fsdk.Annot_e_PolyLine
| 注释类型：折线注释。<PDF参考1.7>中的标准注释之一。
| e_Popup = _fsdk.Annot_e_Popup
| 注释类型：弹出注释。<PDF参考1.7>中的标准注释之一。
| e_PrinterMark = _fsdk.Annot_e_PrinterMark
| 注释类型：印刷标记注释。<PDF参考1.7>中的标准注释之一。
| e_PropertyBorderColor = _fsdk.Annot_e_PropertyBorderColor
| 注释属性：边框颜色。 更多...
| e_PropertyCreationDate = _fsdk.Annot_e_PropertyCreationDate
| 注释属性：创建日期。 更多...
| e_PropertyFillColor = _fsdk.Annot_e_PropertyFillColor
| 注释属性：填充颜色 更多...
| e_PropertyModifiedDate = _fsdk.Annot_e_PropertyModifiedDate
| 注释属性：修改日期。
| e_PSInk = _fsdk.Annot_e_PSInk
| 注释类型：压力敏感墨迹注释。
| e_Redact = _fsdk.Annot_e_Redact
| 注释类型：编辑注释。
| e_RichMedia = _fsdk.Annot_e_RichMedia
| 注释类型：富媒体注释。
| e_Screen = _fsdk.Annot_e_Screen
| 注释类型：屏幕注释。<PDF参考1.7>中的标准注释之一。
| e_Sound = _fsdk.Annot_e_Sound
| 注释类型：声音注释。<PDF参考1.7>中的标准注释之一。
| e_Square = _fsdk.Annot_e_Square
| 注释类型：矩形注释。<PDF参考1.7>中的标准注释之一。
| e_Squiggly = _fsdk.Annot_e_Squiggly
| 注释类型：波浪线注释。<PDF参考1.7>中的标准注释之一。
| e_Stamp = _fsdk.Annot_e_Stamp
| 注释类型：印章注释。<PDF参考1.7>中的标准注释之一。
| e_StrikeOut = _fsdk.Annot_e_StrikeOut
| 注释类型：删除线注释。<PDF参考1.7>中的标准注释之一。
| e_TrapNet = _fsdk.Annot_e_TrapNet
| 注释类型：陷阱网络注释。<PDF参考1.7>中的标准注释之一。
| e_Underline = _fsdk.Annot_e_Underline
| 注释类型：下划线注释。<PDF参考1.7>中的标准注释之一。
| e_UnknownType = _fsdk.Annot_e_UnknownType
| 注释类型：未知。
| e_Watermark = _fsdk.Annot_e_Watermark
| 注释类型：水印注释。<PDF参考1.7>中的标准注释之一。
| e_Widget = _fsdk.Annot_e_Widget
| 注释类型：小组件注释。<PDF参考1.7>中的标准注释之一。 更多...

## 详细描述

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

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

参见
  Annot

## 成员函数说明

## ◆ AddReply()

def FoxitPDFSDKPython2.Markup.AddReply | ( |  | ) |

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

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

## ◆ AddRichText()

def FoxitPDFSDKPython2.Markup.AddRichText | ( |  | content,
|  |  | style
| ) |  |

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

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

参数

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

返回
  无。

## ◆ AddStateAnnot()

def FoxitPDFSDKPython2.Markup.AddStateAnnot | ( |  | title,
|  |  | model,
|  |  | state
| ) |  |

添加新的状态注释。

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

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

参数

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

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

## ◆ GetBorderOpacity()

def FoxitPDFSDKPython2.Markup.GetBorderOpacity | ( |  | ) |

获取注释的边框透明度。

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

## ◆ GetCreationDateTime()

def FoxitPDFSDKPython2.Markup.GetCreationDateTime | ( |  | ) |

获取创建日期时间。

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

## ◆ GetFillOpacity()

def FoxitPDFSDKPython2.Markup.GetFillOpacity | ( |  | ) |

获取注释的填充透明度。

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

## ◆ GetGroupElements()

def FoxitPDFSDKPython2.Markup.GetGroupElements | ( |  | ) |

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

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

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

## ◆ GetGroupHeader()

def FoxitPDFSDKPython2.Markup.GetGroupHeader | ( |  | ) |

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

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

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

## ◆ GetIntent()

def FoxitPDFSDKPython2.Markup.GetIntent | ( |  | ) |

获取意图名称。

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

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

返回
  意图名称字符串。

## ◆ GetOpacity()

def FoxitPDFSDKPython2.Markup.GetOpacity | ( |  | ) |

获取不透明度值。

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

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

## ◆ GetPopup()

def FoxitPDFSDKPython2.Markup.GetPopup | ( |  | ) |

获取相关的弹出注释。

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

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

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

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

## ◆ GetReply()

def FoxitPDFSDKPython2.Markup.GetReply | ( |  | index | ) |

按索引获取回复。

参数

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

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

## ◆ GetReplyCount()

def FoxitPDFSDKPython2.Markup.GetReplyCount | ( |  | ) |

计算所有回复。

返回
  回复的数量。

## ◆ GetRichTextContent()

def FoxitPDFSDKPython2.Markup.GetRichTextContent | ( |  | index | ) |

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

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

参数

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

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

## ◆ GetRichTextCount()

def FoxitPDFSDKPython2.Markup.GetRichTextCount | ( |  | ) |

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

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

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

## ◆ GetRichTextStyle()

def FoxitPDFSDKPython2.Markup.GetRichTextStyle | ( |  | index | ) |

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

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

参数

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

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

## ◆ GetStateAnnots()

def FoxitPDFSDKPython2.Markup.GetStateAnnots | ( |  | model | ) |

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

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

参数

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

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

## ◆ GetSubject()

def FoxitPDFSDKPython2.Markup.GetSubject | ( |  | ) |

获取主题字符串。

返回
  主题字符串。

## ◆ GetTitle()

def FoxitPDFSDKPython2.Markup.GetTitle | ( |  | ) |

获取标题字符串。

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

返回
  标题字符串。

## ◆ InsertRichText()

def FoxitPDFSDKPython2.Markup.InsertRichText | ( |  | index,
|  |  | content,
|  |  | style
| ) |  |

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

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

参数

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

返回
  无。

## ◆ IsGrouped()

def FoxitPDFSDKPython2.Markup.IsGrouped | ( |  | ) |

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

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

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

## ◆ RemoveAllReplies()

def FoxitPDFSDKPython2.Markup.RemoveAllReplies | ( |  | ) |

删除所有回复。

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

## ◆ RemoveAllStateAnnots()

def FoxitPDFSDKPython2.Markup.RemoveAllStateAnnots | ( |  | ) |

移除所有状态注释。

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

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

## ◆ RemovePopup()

def FoxitPDFSDKPython2.Markup.RemovePopup | ( |  | ) |

删除相关的弹出注释。

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

## ◆ RemoveReply()

def FoxitPDFSDKPython2.Markup.RemoveReply | ( |  | index | ) |

按索引删除回复。

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

参数

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

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

## ◆ RemoveRichText()

def FoxitPDFSDKPython2.Markup.RemoveRichText | ( |  | index | ) |

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

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

参数

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

返回
  无。

## ◆ SetBorderOpacity()

def FoxitPDFSDKPython2.Markup.SetBorderOpacity | ( |  | opacity | ) |

设置注释的边框透明度。

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

参数

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

返回
  None.

## ◆ SetCreationDateTime()

def FoxitPDFSDKPython2.Markup.SetCreationDateTime | ( |  | date_time | ) |

设置创建日期时间。

参数

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

返回
  无。

## ◆ SetFillOpacity()

def FoxitPDFSDKPython2.Markup.SetFillOpacity | ( |  | opacity | ) |

设置注释的填充透明度。

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

参数

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

返回
  无。

## ◆ SetIntent()

def FoxitPDFSDKPython2.Markup.SetIntent | ( |  | intent | ) |

设置意图名称。

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

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

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

参数

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

返回
  无。

## ◆ SetOpacity()

def FoxitPDFSDKPython2.Markup.SetOpacity | ( |  | opacity | ) |

设置不透明度值。

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

参数

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

返回
  无。

## ◆ SetPopup()

def FoxitPDFSDKPython2.Markup.SetPopup | ( |  | popup | ) |

设置相关的弹出注释。

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

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

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

参数

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

返回
  无。

## ◆ SetRichTextContent()

def FoxitPDFSDKPython2.Markup.SetRichTextContent | ( |  | index,
|  |  | content
| ) |  |

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

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

参数

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

返回
  无。

## ◆ SetRichTextStyle()

def FoxitPDFSDKPython2.Markup.SetRichTextStyle | ( |  | index,
|  |  | style
| ) |  |

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

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

参数

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

返回
  无。

## ◆ SetSubject()

def FoxitPDFSDKPython2.Markup.SetSubject | ( |  | subject | ) |

设置主题字符串。

参数

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

返回
  无。

## ◆ SetTitle()

def FoxitPDFSDKPython2.Markup.SetTitle | ( |  | title | ) |

设置标题字符串。

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

参数

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

返回
  无。

## ◆ Ungroup()

def FoxitPDFSDKPython2.Markup.Ungroup | ( |  | ) |

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

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

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