Foxit PDF SDK
FSDK::Popup类 参考
类 FSDK::Popup 继承关系图:
FSDK::Annot

Public 成员函数

 constructor ()
 构造函数。
 
 constructor (annot)
 构造函数,带有父类对象。 更多...
 
 GetOpenStatus ()
 获取打开状态。 更多...
 
 GetParent ()
 获取相关的父标记注释。 更多...
 
 SetOpenStatus (status)
 设置打开状态。 更多...
 
- Public 成员函数 继承自 FSDK::Annot
 constructor ()
 构造函数。
 
 constructor (page, annot_dict)
 带有PDF页面和注释的PDF字典的构造函数。 更多...
 
 GetAppearanceStream (type, appearance_state)
 获取具有指定类型和状态的注释外观流。 更多...
 
 GetBorderColor ()
 获取边框颜色。 更多...
 
 GetBorderInfo ()
 获取边框信息。 更多...
 
 GetContent ()
 获取内容。 更多...
 
 GetDeviceRect (matrix)
 获取设备坐标系中的注释矩形。 更多...
 
 GetDict ()
 获取注释的字典对象。 更多...
 
 GetDisplayMatrix (page_display_matrix)
 获取从PDF坐标系到 目标设备坐标系的显示矩阵。 更多...
 
 GetFlags ()
 获取注释标志。 更多...
 
 GetIndex ()
 获取当前注释在其所属页面中的索引。 更多...
 
 GetModifiedDateTime ()
 获取上次修改日期时间。 更多...
 
 GetOptionalContent ()
 获取注释的可选内容的PDF字典。 更多...
 
 GetPage ()
 获取相关的PDF页面。 更多...
 
 GetRect ()
 获取PDF坐标系中的矩形。 更多...
 
 GetType ()
 获取当前注释的实际注释类型。 更多...
 
 GetUniqueID ()
 获取唯一ID。 更多...
 
 HasProperty (property)
 当前注释是否具有指定的注释属性。 更多...
 
 IsEmpty ()
 检查当前对象是否为空。 更多...
 
 IsMarkup ()
 检查当前注释是否为标记注释。 更多...
 
 Move (rect)
 将当前注释移动到新位置,由PDF坐标系中的新矩形指定。 更多...
 
 Move (rect, is_reset_appearance)
 将当前注释移动到新位置,由PDF坐标系中的新矩形指定。 更多...
 
 RemoveProperty (property)
 移除指定的注释属性。 更多...
 
 ResetAppearanceStream ()
 重置外观流。 更多...
 
 ResetAppearanceStream (is_generate_new_appearance_obj)
 重置外观流。 更多...
 
 SetBorderColor (color)
 设置边框颜色。 更多...
 
 SetBorderInfo (border)
 设置边框信息。 更多...
 
 SetContent (content)
 设置内容。 更多...
 
 SetFlags (flags)
 设置注释标志。 更多...
 
 SetModifiedDateTime (date_time)
 设置上次修改日期时间。 更多...
 
 SetUniqueID (unique_id)
 设置唯一ID。 更多...
 

额外继承的成员函数

- 静态 Public 属性 继承自 FSDK::Annot
static e_3D
 注释类型:3D注释。<PDF reference 1.7>中的标准注释之一。
 
static e_AppearanceTypeDown
 注释的按下外观。
 
static e_AppearanceTypeNormal
 注释外观类型的枚举。 更多...
 
static e_AppearanceTypeRollover
 注释的翻转外观。
 
static e_Caret
 注释类型:插入符注释。<PDF reference 1.7>中的标准注释之一。
 
static e_Circle
 注释类型:圆形注释。<PDF reference 1.7>中的标准注释之一。
 
static e_FileAttachment
 注释类型:文件附件注释。<PDF reference 1.7>中的标准注释之一。
 
static e_FlagHidden
 注释标志:隐藏。 更多...
 
static e_FlagInvisible
 PDF注释标志的枚举。 更多...
 
static e_FlagLocked
 注释标志:锁定。 更多...
 
static e_FlagLockedContents
 注释标志:锁定内容。 更多...
 
static e_FlagNoRotate
 注释标志:不旋转。 更多...
 
static e_FlagNoView
 注释标志:不查看。 更多...
 
static e_FlagNoZoom
 注释标志:不缩放。 更多...
 
static e_FlagPrint
 注释标志:打印。 更多...
 
static e_FlagReadOnly
 注释标志:只读。 更多...
 
static e_FlagToggleNoView
 注释标志:切换不查看。 更多...
 
static e_FreeText
 注释类型:自由文本注释。<PDF reference 1.7>中的标准注释之一。
 
static e_Highlight
 注释类型:高亮注释。<PDF reference 1.7>中的标准注释之一。
 
static e_HighlightingInvert
 高亮模式:反转,即反转注释矩形的内容。
 
static e_HighlightingNone
 PDF注释高亮模式的枚举。 更多...
 
static e_HighlightingOutline
 高亮模式:轮廓,即反转注释的边框。
 
static e_HighlightingPush
 高亮模式:按下,即显示注释的按下外观(如果有)。
 
static e_HighlightingToggle
 高亮模式:切换。这仅对小部件注释有用。
 
static e_Ink
 注释类型:墨迹注释。<PDF reference 1.7>中的标准注释之一。
 
static e_Line
 注释类型:直线注释。<PDF reference 1.7>中的标准注释之一。
 
static e_Link
 注释类型:链接注释。<PDF reference 1.7>中的标准注释之一。
 
static e_MKEntryBackgroundColor
 背景颜色条目。MK字典中的"BG"。
 
static e_MKEntryBorderColor
 边框颜色条目。MK字典中的"BC"。
 
static e_MKEntryDownCaption
 按下标题(或替代标题)条目。MK字典中的"AC"。 更多...
 
static e_MKEntryDownIcon
 按下图标(或替代图标)条目。MK字典中的"IX"。 更多...
 
static e_MKEntryIconCaptionRelation
 图标和标题关系条目。MK字典中的"TP"。 更多...
 
static e_MKEntryIconFit
 图标适配信息条目。MK字典中的"IF"。 更多...
 
static e_MKEntryNormalCaption
 正常标题条目。MK字典中的"CA"。 更多...
 
static e_MKEntryNormalIcon
 正常图标条目。MK字典中的"I"。 更多...
 
static e_MKEntryRolloverCaption
 翻转标题条目。MK字典中的"RC"。 更多...
 
static e_MKEntryRolloverIcon
 翻转图标条目。MK字典中的"RI"。 更多...
 
static e_MKEntryRotation
 注释的MK字典(外观特性)条目的枚举。 更多...
 
static e_MKRelationCaptionAboveIcon
 标题在图标上方。
 
static e_MKRelationCaptionBelowIcon
 标题在图标下方。
 
static e_MKRelationCaptionLeft
 标题在图标左侧。
 
static e_MKRelationCaptionOvrlayOnIcon
 标题直接覆盖在图标上。
 
static e_MKRelationCaptionRight
 标题在图标右侧。
 
static e_MKRelationNoCaption
 无标题;仅图标。
 
static e_MKRelationNoIcon
 注释的MK字典中图标和标题相对位置的枚举。 更多...
 
static e_Movie
 注释类型:电影注释。<PDF reference 1.7>中的标准注释之一。
 
static e_Note
 注释类型:注释注释,即“文本”注释 - <PDF reference 1.7>中的标准注释之一。
 
static e_PagingSeal
 注释类型:分页印章注释。Foxit PDF SDK自定义注释类型(非标准注释类型)。
 
static e_Polygon
 注释类型:多边形注释。<PDF reference 1.7>中的标准注释之一。
 
static e_PolyLine
 注释类型:折线注释。<PDF reference 1.7>中的标准注释之一。
 
static e_Popup
 注释类型:弹出注释。<PDF reference 1.7>中的标准注释之一。
 
static e_PrinterMark
 注释类型:印刷商标记注释。<PDF reference 1.7>中的标准注释之一。
 
static e_PropertyBorderColor
 注释属性:边框颜色。 更多...
 
static e_PropertyCreationDate
 注释属性:创建日期。 更多...
 
static e_PropertyFillColor
 注释属性:填充颜色 更多...
 
static e_PropertyModifiedDate
 某些PDF注释属性的枚举。 更多...
 
static e_PSInk
 注释类型:压感墨迹注释。
 
static e_Redact
 注释类型:涂黑注释。
 
static e_RichMedia
 注释类型:富媒体注释。
 
static e_Screen
 注释类型:屏幕注释。<PDF reference 1.7>中的标准注释之一。
 
static e_Sound
 注释类型:声音注释。<PDF reference 1.7>中的标准注释之一。
 
static e_Square
 注释类型:正方形注释。<PDF reference 1.7>中的标准注释之一。
 
static e_Squiggly
 注释类型:波浪线注释。<PDF reference 1.7>中的标准注释之一。
 
static e_Stamp
 注释类型:图章注释。<PDF reference 1.7>中的标准注释之一。
 
static e_StrikeOut
 注释类型:删除线注释。<PDF reference 1.7>中的标准注释之一。
 
static e_TrapNet
 注释类型:陷阱网络注释。<PDF reference 1.7>中的标准注释之一。
 
static e_Underline
 注释类型:下划线注释。<PDF reference 1.7>中的标准注释之一。
 
static e_UnknownType
 PDF注释类型的枚举。 更多...
 
static e_Watermark
 注释类型:水印注释。<PDF reference 1.7>中的标准注释之一。
 
static e_Widget
 注释类型:小部件注释。<PDF reference 1.7>中的标准注释之一。 更多...
 

详细描述

弹出式注释在弹出式窗口中显示文本以便输入和编辑。它通常不单独出现, 而是与标记注释(其父注释)关联,并用于编辑父注释的文本。
FSDK.Popup 派生自类 FSDK.Annot,并且还提供了获取/设置弹出式注释属性的函数。 弹出式注释本身没有外观流或关联的动作,因此对于弹出式注释,函数 FSDK.Annot.ResetAppearanceStream 将始终返回 false

参见
FSDK.Annot

成员函数说明

◆ constructor()

FSDK::Popup::constructor ( annot  )

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

参数
[in]annot父类对象。

◆ GetOpenStatus()

FSDK::Popup::GetOpenStatus ( )

获取打开状态。

打开状态是一个布尔值,指定注释是否应在初始时以打开状态显示:

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

◆ GetParent()

FSDK::Popup::GetParent ( )

获取相关的父标记注释。

返回
相关的父标记注释。如果返回的标记注释的函数 FSDK.Annot.IsEmpty (从 FSDK.Markup 的父类继承)的返回值为 true, 则表示当前弹出式注释没有标记注释。

◆ SetOpenStatus()

FSDK::Popup::SetOpenStatus ( status  )

设置打开状态。

打开状态是一个布尔值,指定注释是否应在初始时以打开状态显示:

  • true 表示注释应在初始时以打开状态显示。
  • false 表示注释应在初始时以关闭状态显示。
参数
[in]status新的打开状态值。
返回
None.