Foxit PDF SDK
Public 成员函数 | 所有成员列表
FSDK::Note类 参考

Public 成员函数

 constructor ()
 构造函数。
 
 constructor (annot)
 带有父类对象的构造函数。 更多...
 
 GetIconName ()
 获取图标名称。 更多...
 
 GetOpenStatus ()
 获取打开状态。 更多...
 
 GetReplyTo ()
 获取当前注释注释回复的标记注释。 更多...
 
 GetState ()
 获取状态。 更多...
 
 GetStateModel ()
 获取状态模型。 更多...
 
 IsStateAnnot ()
 检查当前注释注释是否用作状态注释。 更多...
 
 SetIconName (icon_name)
 设置图标名称。 更多...
 
 SetOpenStatus (status)
 设置打开状态。 更多...
 
 SetState (state)
 设置状态。 更多...
 

详细描述

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

  • 当作为回复时，注释注释不应该单独显示，而应该与其他回复一起以 线程式评论的形式显示。函数FSDK.Note.GetReplyTo可用于获取 注释注释回复的标记注释。
  • 当作为状态时，注释注释不会单独显示。函数FSDK.Note.IsStateAnnot 可用于判断注释注释是否用作状态。

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

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

成员函数说明

◆ constructor()

FSDK::Note::constructor ( annot  )

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

参数
[in]annot父类对象。

◆ GetIconName()

FSDK::Note::GetIconName ( )

获取图标名称。

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

返回
图标名称字符串。

◆ GetOpenStatus()

FSDK::Note::GetOpenStatus ( )

获取打开状态。

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

  • true表示注释注释应该初始为打开状态显示。
  • false表示注释注释应该初始为关闭状态显示。
返回
打开状态。

◆ GetReplyTo()

FSDK::Note::GetReplyTo ( )

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

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

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

◆ GetState()

FSDK::Note::GetState ( )

获取状态。

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

返回
状态。请参考从FSDK.Markup.e_StateMarked开始的值， 这将是这些值之一。 如果当前注释注释不是状态注释，此函数将返回0。

◆ GetStateModel()

FSDK::Note::GetStateModel ( )

获取状态模型。

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

返回
状态模型。如果函数成功，返回值将是 FSDK.Markup.e_StateModelMarked或FSDK.Markup.e_StateModelReview。
如果当前注释注释不是状态注释，此函数将返回0。

◆ IsStateAnnot()

FSDK::Note::IsStateAnnot ( )

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

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

◆ SetIconName()

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()

FSDK::Note::SetOpenStatus ( status  )

设置打开状态。

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

  • true表示注释注释应该初始为打开状态显示。
  • false表示注释注释应该初始为关闭状态显示。
参数
[in]status新的打开状态值。
返回
无。

◆ SetState()

FSDK::Note::SetState ( state  )

设置状态。

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

参数
[in]state新状态。它应该是以下值之一： 状态模型可以通过函数FSDK.Note.GetStateModel获取。
返回
无。