fsdk.Note类 参考

Public 成员函数
def	GetIconName ()
	获取图标名称。 更多...
def	GetOpenStatus ()
	获取开放状态。 更多...
def	GetReplyTo ()
	获取当前注记注释回复的标记注释。 更多...
def	GetState ()
	获取状态。 更多...
def	GetStateModel ()
	获取状态模型。 更多...
def	IsStateAnnot ()
	检查当前注记注释是否用作状态注释。 更多...
def	SetIconName (icon_name)
	设置图标名称。 更多...
def	SetOpenStatus (status)
	设置开放状态。 更多...
def	SetState (state)
	设置状态。 更多...

详细描述

注记注释（在<PDF参考1.7>中称为"文本"注释）表示附加到PDF文档中某个点的"便签"。 当关闭时，注释显示为图标；当打开时，它显示一个弹出窗口，其中包含由查看器应用程序选择的字体和大小的注记文本。
注记注释也可以用作标记注释的回复或状态注释：

• 当作为回复时，注记注释不应单独显示，而应与其他回复一起以线程评论的形式显示。 函数 fsdk.Note.GetReplyTo 可用于获取注记注释回复的标记注释。

• 当作为状态时，注记注释不会单独显示。函数 fsdk.Note.IsStateAnnot 可用于判断注记注释是否用作状态。

注记注释是一种标记注释，因此类Note 派生自 类Markup 。它提供获取/设置注记注释属性和 重置注记注释外观的函数。

注解

对于新创建的普通注记注释，如果用户直接调用函数fsdk.Annot.ResetAppearanceStream 而不设置任何属性，将使用默认外观：
边框颜色 = 0xFFFFFF00（黄色），不透明度 = 1.0，图标名称 = "Comment"。

参见

Markup

成员函数说明

GetIconName()

def fsdk.Note.GetIconName

(

)

获取图标名称。

此属性对便签注释的外观有影响。便签注释具有预定义的标准图标 名称：
"Check"、"Circle"、"Comment"、"Cross"、"Help"、"Insert"、"Key"、"NewParagraph"、"Note"、"Paragraph"、 "RightArrow"、"RightPointer"、"Star"、"UpArrow"、"UpLeftArrow"。
空的图标名称字符串表示当前便签注释将被视为"Note"图标。

返回

图标名称字符串。

GetOpenStatus()

def fsdk.Note.GetOpenStatus

(

)

获取开放状态。

开放状态是一个布尔值，指定注记注释是否应初始显示为打开状态：

• true 表示注记注释应初始显示为打开状态。

• false 表示注记注释应初始显示为关闭状态。

返回

开放状态。

GetReplyTo()

def fsdk.Note.GetReplyTo

(

)

获取当前注记注释回复的标记注释。

此函数仅在当前注记注释用作回复时有用。

返回

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

GetState()

def fsdk.Note.GetState

(

)

获取状态。

此函数只能在当前注记注释用作状态注释时使用。 函数 fsdk.Note.IsStateAnnot 可用于检查当前注记注释是否用作状态注释。

返回

状态。请参考从 fsdk.MarkupE_StateMarked 开始的值， 这将是这些值中的一个。 如果当前注记注释不是状态注释，此函数将返回 0。

GetStateModel()

def fsdk.Note.GetStateModel

(

)

获取状态模型。

此函数只能在当前注记注释用作状态注释时使用。 函数 fsdk.Note.IsStateAnnot 可用于检查当前注记注释是否用作状态注释。

返回

状态模型。如果函数成功，返回值将是 fsdk.MarkupE_StateModelMarked 或 fsdk.MarkupE_StateModelReview 。
如果当前注记注释不是状态注释，此函数将返回 0。

IsStateAnnot()

def fsdk.Note.IsStateAnnot

(

)

检查当前注记注释是否用作状态注释。

返回

true 表示当前注记注释用作状态注释， false 表示当前注记注释只是普通的注记注释。

SetIconName()

def fsdk.Note.SetIconName

(

icon_name

)

设置图标名称。

此属性对便签注释的外观有影响。便签注释具有预定义的标准图标 名称：
"Check"、"Circle"、"Comment"、"Cross"、"Help"、"Insert"、"Key"、"NewParagraph"、"Note"、"Paragraph"、 "RightArrow"、"RightPointer"、"Star"、"UpArrow"、"UpLeftArrow"。
空的图标名称字符串表示当前便签注释将被视为"Note"图标。
对于新创建的便签注释，如果未调用当前函数，图标名称默认为 "Comment"。
如果用户希望新的图标名称对注释的外观有影响，请在设置新图标名称后调用函数 fsdk.Annot.ResetAppearanceStream 。

参数

[in]

icon_name

要设置的新图标名称字符串。

返回

无。

SetOpenStatus()

def fsdk.Note.SetOpenStatus

(

status

)

设置开放状态。

开放状态是一个布尔值，指定注记注释是否应初始显示为打开状态：

• true 表示注记注释应初始显示为打开状态。

• false 表示注记注释应初始显示为关闭状态。

参数

[in]

status

新的开放状态值。

返回

无。

SetState()

def fsdk.Note.SetState

(

state

)

设置状态。

此函数只能在当前注记注释用作状态注释时使用。 函数 fsdk.Note.IsStateAnnot 可用于检查当前注记注释是否用作状态注释。

参数

[in]

state

新状态。应为以下值之一： 如果状态模型是 fsdk.MarkupE_StateModelMarked ， 状态应为 fsdk.MarkupE_StateMarked 或 fsdk.MarkupE_StateUnmarked 。 如果状态模型是 fsdk.MarkupE_StateModelReview ， 状态应为 fsdk.MarkupE_StateAccepted 、fsdk.MarkupE_StateRejected 、 fsdk.MarkupE_StateCancelled 、fsdk.MarkupE_StateCompleted 、 fsdk.MarkupE_StateDeferred 、fsdk.MarkupE_StateFuture 或 fsdk.MarkupE_StateNone 。 状态模型可以通过函数 fsdk.Note.GetStateModel 获取。

返回

无。