fsdk.Screen类 参考

Public 成员函数
def	GetAction ()
	获取动作。 更多...
def	GetBitmap ()
	从当前屏幕注释获取位图。 更多...
def	GetMKDict ()
	获取外观特征字典（也称为"MK"字典）。 更多...
def	GetOpacity ()
	获取不透明度值。 更多...
def	GetRotation ()
	获取用于当前屏幕注释外观的图像旋转。 更多...
def	GetTitle ()
	获取当前屏幕注释的标题。 更多...
def	RemoveAction ()
	移除动作。 更多...
def	SetAction (action)
	设置动作。 更多...
def	SetImage (image, frame_index, compress)
	为当前屏幕注释设置图像，使用指定的帧索引。 更多...
def	SetMKDict (dict)
	设置外观特征字典（也称为"MK"字典）。 更多...
def	SetOpacity (opacity)
	设置不透明度值。 更多...
def	SetRotation (rotate)
	设置用于当前屏幕注释外观的图像旋转。 更多...
def	SetTitle (title)
	设置当前屏幕注释的标题。 更多...

详细描述

屏幕注释指定页面上可以播放媒体剪辑的区域。它还作为可以触发动作的对象。 通常，演出动作被设置给屏幕注释，以便屏幕注释可以用于播放媒体剪辑。
类fsdk.Screen 派生自Annot ，并提供获取/设置链接注释属性和 重置屏幕注释外观流的函数。屏幕注释的外观流用于打印（如果可能） 以及当相关媒体剪辑未播放时。

注解

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

参见

Annot

成员函数说明

GetAction()

def fsdk.Screen.GetAction

(

)

获取动作。

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

返回

接收动作数据的动作对象。如果返回的动作对象的函数 fsdk.Action.IsEmpty 的返回值为true，那意味着没有动作。

GetBitmap()

def fsdk.Screen.GetBitmap

(

)

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

返回

位图对象。如果返回的位图对象的函数fsdk.Bitmap.IsEmpty 的返回值为true，那意味着当前屏幕注释没有位图。

GetMKDict()

def fsdk.Screen.GetMKDict

(

)

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

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

返回

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

GetOpacity()

def fsdk.Screen.GetOpacity

(

)

获取不透明度值。

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

返回

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

GetRotation()

def fsdk.Screen.GetRotation

(

)

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

返回

图像的旋转值。请参考从fsdk.E_Rotation0 开始的值， 这将是这些值中的一个。

GetTitle()

def fsdk.Screen.GetTitle

(

)

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

返回

标题字符串。

RemoveAction()

def fsdk.Screen.RemoveAction

(

)

移除动作。

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

返回

无。

SetAction()

def fsdk.Screen.SetAction

(

action

)

设置动作。

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

参数

[in]

action

要设置的新动作。它应该是有效的。 目前只支持以下类型作为新动作： fsdk.ActionE_TypeGoto 、 fsdk.ActionE_TypeURI 、 fsdk.ActionE_TypeJavaScript 、 fsdk.ActionE_TypeNamed 、 fsdk.ActionE_TypeGoToR 、 fsdk.ActionE_TypeGoToE 、 fsdk.ActionE_TypeSubmitForm 、 fsdk.ActionE_TypeResetForm 、 fsdk.ActionE_TypeHide 、 fsdk.ActionE_TypeLaunch 、 fsdk.ActionE_TypeImportData 、 fsdk.ActionE_TypeRendition 。

返回

无。

SetImage()

def fsdk.Screen.SetImage	(		image,
			frame_index,
			compress
	)

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

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

参数

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

返回

无。

SetMKDict()

def fsdk.Screen.SetMKDict

(

dict

)

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

参数

[in]

dict

表示要设置的新"MK"字典的PDF字典。 用户在将其设置给屏幕注释后不应释放此字典。

SetOpacity()

def fsdk.Screen.SetOpacity

(

opacity

)

设置不透明度值。

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

参数

[in]

opacity

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

返回

无。

SetRotation()

def fsdk.Screen.SetRotation

(

rotate

)

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

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

参数

[in]

rotate

旋转值。请参考从fsdk.E_Rotation0 开始的值， 这应该是这些值中的一个，除了fsdk.E_RotationUnknown 。

返回

无。

SetTitle()

def fsdk.Screen.SetTitle

(

title

)

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

参数

[in]

title

要设置的标题字符串。

返回

无。