类 FSDK::Screen 继承关系图:

Public 成员函数
	constructor ()
	构造函数。

	constructor (annot)
	构造函数，带有父类对象。更多...

	GetAction ()
	获取动作。更多...

	GetBitmap ()
	从当前屏幕注释获取位图。更多...

	GetMKDict ()
	获取外观特征字典（也称为 "MK" 字典）。更多...

	GetOpacity ()
	获取不透明度值。更多...

	GetRotation ()
	获取用于当前屏幕注释外观的图像旋转。更多...

	GetTitle ()
	获取当前屏幕注释的标题。更多...

	RemoveAction ()
	移除动作。更多...

	SetAction (action)
	设置动作。更多...

	SetImage (image, frame_index, compress)
	使用指定的帧索引为当前屏幕注释设置图像。更多...

	SetMKDict (dict)
	设置外观特征字典（也称为 "MK" 字典）。更多...

	SetOpacity (opacity)
	设置不透明度值。更多...

	SetRotation (rotate)
	设置用于当前屏幕注释外观的图像旋转。更多...

	SetTitle (title)
	设置当前屏幕注释的标题。更多...

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.Screen 派生自 FSDK.Annot，并提供获取/设置屏幕注释属性和重置屏幕注释外观流的函数。屏幕注释的外观流用于打印（如果可能）以及当相关媒体剪辑未播放时。

注解: 对于新创建的屏幕注释，它没有边框信息和边框颜色。

参见: FSDK.Annot

成员函数说明

◆ constructor()

FSDK::Screen::constructor ( annot )

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

参数

[in] annot 父类对象。

◆ GetAction()

FSDK::Screen::GetAction ( )

获取动作。

此函数不能用于获取用作附加动作的动作。如果用户想要获取任何附加动作，请参考类 FSDK.AdditionalAction 以获取更多详细信息。

返回: 接收动作数据的动作对象。如果返回的动作对象的函数 FSDK.Action.IsEmpty 的返回值为 true，则表示没有动作。

◆ GetBitmap()

FSDK::Screen::GetBitmap ( )

从当前屏幕注释获取位图。

返回: 位图对象。如果返回的位图对象的函数 FSDK.Bitmap.IsEmpty 的返回值为 true，则表示当前屏幕注释没有位图。

◆ GetMKDict()

FSDK::Screen::GetMKDict ( )

获取外观特征字典（也称为 "MK" 字典）。

如果此字典未设置到屏幕注释（包括当前一个），请调用函数 FSDK.PDFObject.Release （从 FSDK.PDFDictionary 的父类继承）来释放它。

返回: 表示 "MK" 字典的 PDF 字典。如果没有 "MK" 条目或发生任何错误，此函数将返回 null。

◆ GetOpacity()

FSDK::Screen::GetOpacity ( )

获取不透明度值。

此属性会影响注释的外观。

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

◆ GetRotation()

FSDK::Screen::GetRotation ( )

获取用于当前屏幕注释外观的图像旋转。

返回: 图像的旋转值。请参考从 FSDK.e_Rotation0 开始的值，这将是这些值中的一个。

◆ GetTitle()

FSDK::Screen::GetTitle ( )

获取当前屏幕注释的标题。

返回: 标题字符串。

◆ RemoveAction()

FSDK::Screen::RemoveAction ( )

移除动作。

此函数不能用于移除用作附加动作的动作。如果用户想要移除任何附加动作，请参考类 FSDK.AdditionalAction 以获取更多详细信息。

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

◆ SetAction()

FSDK::Screen::SetAction ( action )

设置动作。

此函数不能用于设置用作附加动作的动作。如果用户想要设置任何附加动作，请参考类 FSDK.AdditionalAction 以获取更多详细信息。

参数

[in] action 要设置的新动作。它应该是有效的。目前仅支持以下类型作为新动作：
FSDK.Action.e_TypeGoto、 FSDK.Action.e_TypeURI、 FSDK.Action.e_TypeJavaScript、 FSDK.Action.e_TypeNamed、 FSDK.Action.e_TypeGoToR、 FSDK.Action.e_TypeGoToE、 FSDK.Action.e_TypeSubmitForm、 FSDK.Action.e_TypeResetForm、 FSDK.Action.e_TypeHide、 FSDK.Action.e_TypeLaunch、 FSDK.Action.e_TypeImportData、 FSDK.Action.e_TypeRendition。

返回: None.

◆ SetImage()

FSDK::Screen::SetImage	(	image	,
		frame_index	,
		compress
	)

使用指定的帧索引为当前屏幕注释设置图像。

输入图像可能包含多个帧，只能将图像的一帧设置到当前印章注释。
如果用户希望此效果显示在注释的外观中，请在此函数后调用函数 FSDK.Annot.ResetAppearanceStream。

参数

[in]	image	一个图像。其中一帧将被设置到当前印章。此图像至少包含一帧，且图像类型不应为 FSDK.Image.e_Unknown。
[in]	frame_index	帧索引。有效范围：从 0 到 (count-1)。 count 由函数 FSDK.Image.GetFrameCount 返回。
[in]	compress	用于压缩图像数据的压缩算法类型。目前仅支持 2 个有效值： 0: 不压缩。 1: 执行默认压缩。

返回: None.

◆ SetMKDict()

FSDK::Screen::SetMKDict ( dict )

设置外观特征字典（也称为 "MK" 字典）。

参数

[in] dict 表示要设置的新 "MK" 字典的 PDF 字典。用户在将此字典设置到屏幕注释后不应释放它。

◆ SetOpacity()

FSDK::Screen::SetOpacity ( opacity )

设置不透明度值。

此属性会影响注释的外观。如果用户希望此效果显示在注释的外观中，请在此函数后调用函数 FSDK.Annot.ResetAppearanceStream。

参数

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

返回: None.

◆ SetRotation()

FSDK::Screen::SetRotation ( rotate )

设置用于当前屏幕注释外观的图像旋转。

此属性会影响注释的外观。如果用户希望此效果显示在注释的外观中，请在此函数后调用函数 FSDK.Annot.ResetAppearanceStream。

参数

[in] rotate 旋转值。请参考从 FSDK.e_Rotation0 开始的值，这应该是这些值中的一个，但不包括 FSDK.e_RotationUnknown。

返回: None.

◆ SetTitle()

FSDK::Screen::SetTitle ( title )

设置当前屏幕注释的标题。

参数

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

返回: None.

Public 成员函数

额外继承的成员函数

详细描述

成员函数说明

◆ constructor()

◆ GetAction()

◆ GetBitmap()

◆ GetMKDict()

◆ GetOpacity()

◆ GetRotation()

◆ GetTitle()

◆ RemoveAction()

◆ SetAction()

◆ SetImage()

◆ SetMKDict()

◆ SetOpacity()

◆ SetRotation()

◆ SetTitle()