Public 成员函数
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 ()
	将当前标记注释从其所属的组中解组。更多...

详细描述

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

注解

目前，以下类型的函数仅支持注记、高亮、下划线、删除线、波浪线、矩形、圆形、自由文本、印章、插入符、墨迹、直线、多边形、折线、文件附件注释：

类Markup 中的所有"set"函数。
函数fsdk.Annot.ResetAppearanceStream （从Markup 的父类继承）。

参见: Annot

成员函数说明

◆ AddReply()

def fsdk.Markup.AddReply ( )

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

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

◆ AddRichText()

def fsdk.Markup.AddRichText	(	content,
		style
	)

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

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

参数

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

返回: 无。

◆ AddStateAnnot()

def fsdk.Markup.AddStateAnnot	(	title,
		model,
		state
	)

添加新的状态注释。

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

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

参数

[in]	title	新状态注释的标题。标题可用于识别添加当前注释的用户。这可以是空字符串，但强烈建议用户在使用此函数时设置有意义的标题。
[in]	model	新状态注释的状态模型。应为以下值之一： fsdk.MarkupE_StateModelMarked fsdk.MarkupE_StateModelReview
[in]	state	新状态注释的状态值。应为以下值之一：如果参数 model 是 fsdk.MarkupE_StateModelMarked ，状态应为 fsdk.MarkupE_StateMarked 或 fsdk.MarkupE_StateUnmarked 。如果参数 model 是 fsdk.MarkupE_StateModelReview ，状态应为 fsdk.MarkupE_StateAccepted 、fsdk.MarkupE_StateRejected 、 fsdk.MarkupE_StateCancelled 、fsdk.MarkupE_StateCompleted 、 fsdk.MarkupE_StateDeferred 、fsdk.MarkupE_StateFuture 或 fsdk.MarkupE_StateNone 。

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

◆ GetBorderOpacity()

def fsdk.Markup.GetBorderOpacity ( )

获取注释的边框透明度。

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

◆ GetCreationDateTime()

def fsdk.Markup.GetCreationDateTime ( )

获取创建日期时间。

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

◆ GetFillOpacity()

def fsdk.Markup.GetFillOpacity ( )

获取注释的填充透明度。

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

◆ GetGroupElements()

def fsdk.Markup.GetGroupElements ( )

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

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

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

◆ GetGroupHeader()

def fsdk.Markup.GetGroupHeader ( )

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

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

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

◆ GetIntent()

def fsdk.Markup.GetIntent ( )

获取意图名称。

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

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

返回: 意图名称字符串。

◆ GetOpacity()

def fsdk.Markup.GetOpacity ( )

获取不透明度值。

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

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

◆ GetPopup()

def fsdk.Markup.GetPopup ( )

获取相关的弹出注释。

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

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

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

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

◆ GetReply()

def fsdk.Markup.GetReply ( index )

按索引获取回复。

参数

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

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

◆ GetReplyCount()

def fsdk.Markup.GetReplyCount ( )

计算所有回复。

返回: 回复的数量。

◆ GetRichTextContent()

def fsdk.Markup.GetRichTextContent ( index )

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

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

参数

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

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

◆ GetRichTextCount()

def fsdk.Markup.GetRichTextCount ( )

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

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

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

◆ GetRichTextStyle()

def fsdk.Markup.GetRichTextStyle ( index )

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

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

参数

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

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

◆ GetStateAnnots()

def fsdk.Markup.GetStateAnnots ( model )

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

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

参数

[in]

model

状态模型。应为以下值之一：

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

◆ GetSubject()

def fsdk.Markup.GetSubject ( )

获取主题字符串。

返回: 主题字符串。

◆ GetTitle()

def fsdk.Markup.GetTitle ( )

获取标题字符串。

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

返回: 标题字符串。

◆ InsertRichText()

def fsdk.Markup.InsertRichText	(	index,
		content,
		style
	)

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

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

参数

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

返回: 无。

◆ IsGrouped()

def fsdk.Markup.IsGrouped ( )

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

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

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

◆ RemoveAllReplies()

def fsdk.Markup.RemoveAllReplies ( )

删除所有回复。

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

◆ RemoveAllStateAnnots()

def fsdk.Markup.RemoveAllStateAnnots ( )

移除所有状态注释。

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

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

◆ RemovePopup()

def fsdk.Markup.RemovePopup ( )

删除相关的弹出注释。

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

◆ RemoveReply()

def fsdk.Markup.RemoveReply ( index )

按索引删除回复。

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

参数

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

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

◆ RemoveRichText()

def fsdk.Markup.RemoveRichText ( index )

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

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

参数

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

返回: 无。

◆ SetBorderOpacity()

def fsdk.Markup.SetBorderOpacity ( opacity )

设置注释的边框透明度。

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

参数

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

返回: None.

◆ SetCreationDateTime()

def fsdk.Markup.SetCreationDateTime ( date_time )

设置创建日期时间。

参数

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

返回: 无。

◆ SetFillOpacity()

def fsdk.Markup.SetFillOpacity ( opacity )

设置注释的填充透明度。

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

参数

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

返回: 无。

◆ SetIntent()

def fsdk.Markup.SetIntent ( intent )

设置意图名称。

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

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

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

参数

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

返回: 无。

◆ SetOpacity()

def fsdk.Markup.SetOpacity ( opacity )

设置不透明度值。

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

参数

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

返回: 无。

◆ SetPopup()

def fsdk.Markup.SetPopup ( popup )

设置相关的弹出注释。

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

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

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

参数

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

返回: 无。

◆ SetRichTextContent()

def fsdk.Markup.SetRichTextContent	(	index,
		content
	)

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

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

参数

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

返回: 无。

◆ SetRichTextStyle()

def fsdk.Markup.SetRichTextStyle	(	index,
		style
	)

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

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

参数

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

返回: 无。

◆ SetSubject()

def fsdk.Markup.SetSubject ( subject )

设置主题字符串。

参数

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

返回: 无。

◆ SetTitle()

def fsdk.Markup.SetTitle ( title )

设置标题字符串。

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

参数

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

返回: 无。

◆ Ungroup()

def fsdk.Markup.Ungroup ( )

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

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

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

Public 成员函数

详细描述

成员函数说明

◆ AddReply()

◆ AddRichText()

◆ AddStateAnnot()

◆ GetBorderOpacity()

◆ GetCreationDateTime()

◆ GetFillOpacity()

◆ GetGroupElements()

◆ GetGroupHeader()

◆ GetIntent()

◆ GetOpacity()

◆ GetPopup()

◆ GetReply()

◆ GetReplyCount()

◆ GetRichTextContent()

◆ GetRichTextCount()

◆ GetRichTextStyle()

◆ GetStateAnnots()

◆ GetSubject()

◆ GetTitle()

◆ InsertRichText()

◆ IsGrouped()

◆ RemoveAllReplies()

◆ RemoveAllStateAnnots()

◆ RemovePopup()

◆ RemoveReply()

◆ RemoveRichText()

◆ SetBorderOpacity()

◆ SetCreationDateTime()

◆ SetFillOpacity()

◆ SetIntent()

◆ SetOpacity()

◆ SetPopup()

◆ SetRichTextContent()

◆ SetRichTextStyle()

◆ SetSubject()

◆ SetTitle()

◆ Ungroup()