|
Foxit PDF SDK
|
Public Member Functions | |
| def | GetAction () |
| Get action. More... | |
| def | GetBitmap () |
| Get the bitmap from current screen annotation. More... | |
| def | GetMKDict () |
| Get the appearance characteristics dictionary (known as "MK" dictionary as well). More... | |
| def | GetOpacity () |
| Get opacity value. More... | |
| def | GetRotation () |
| Get the rotation of the image used for the appearance of current screen annotation. More... | |
| def | GetTitle () |
| Get title of current screen annotation. More... | |
| def | RemoveAction () |
| Remove action. More... | |
| def | SetAction (action) |
| Set action. More... | |
| def | SetImage (image, frame_index, compress) |
| Set image to current screen annotation, with a specified frame index. More... | |
| def | SetMKDict (dict) |
| Set the appearance characteristics dictionary (known as "MK" dictionary as well). More... | |
| def | SetOpacity (opacity) |
| Set opacity value. More... | |
| def | SetRotation (rotate) |
| Set the rotation of the image used for the appearance of current screen annotation. More... | |
| def | SetTitle (title) |
| Set title of current screen annotation. More... | |
A screen annotation specifies a region of a page upon which media clips may be played. It also serves as an object from which actions can be triggered. Usually, rendition action is set to a screen annotation in order that the screen annotation can be used to play media clip.
Class fsdk.Screen is derived from Annot , and offers functions to get/set link annotation's properties and reset appearance stream of a screen annotation. Appearance stream of a screen annotation is used for printing (if possible) and when the related media clip is not being played.
| def fsdk.Screen.GetAction | ( | ) |
Get action.
This function cannot be used to get action which is used as additional action. If user wants to get any additional action, please refer to class fsdk.AdditionalAction for more details.
| def fsdk.Screen.GetBitmap | ( | ) |
Get the bitmap from current screen annotation.
| def fsdk.Screen.GetMKDict | ( | ) |
Get the appearance characteristics dictionary (known as "MK" dictionary as well).
If this dictionary is not set to a screen annotation (including current one), please call function fsdk.PDFObject.Release (inherited from fsdk.PDFDictionary 's parent class) to release it.
| def fsdk.Screen.GetOpacity | ( | ) |
Get opacity value.
This property has effect on annotation's appearance.
| def fsdk.Screen.GetRotation | ( | ) |
Get the rotation of the image used for the appearance of current screen annotation.
| def fsdk.Screen.GetTitle | ( | ) |
Get title of current screen annotation.
| def fsdk.Screen.RemoveAction | ( | ) |
Remove action.
This function cannot be used to remove action which is used as additional action. If user wants to remove any additional action, please refer to class fsdk.AdditionalAction for more details.
| def fsdk.Screen.SetAction | ( | action | ) |
Set action.
This function cannot be used to set action which is used as additional action. If user wants to set any additional action, please refer to class fsdk.AdditionalAction for more details.
| [in] | action | New action to be set. It should be valid. Currently only support following types as the new 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 . |
| def fsdk.Screen.SetImage | ( | image, | |
| frame_index, | |||
| compress | |||
| ) |
Set image to current screen annotation, with a specified frame index.
Input image may contain multiple frames, and only one frame of the image can be set to current stamp annotation.
If user wants the effect to be shown in annotation's appearance, please call function fsdk.Annot.ResetAppearanceStream after this function.
| [in] | image | An image. One of its frames will be set to current stamp. This image contains at least one frame and the image type should not be fsdk.ImageE_Unknown . |
| [in] | frame_index | Frame index. Valid range: from 0 to (count-1). count is returned by function fsdk.Image.GetFrameCount . |
| [in] | compress | Compress algorithm type used to compress image data. Currently, it only supports 2 valid value:
|
| def fsdk.Screen.SetMKDict | ( | dict | ) |
Set the appearance characteristics dictionary (known as "MK" dictionary as well).
| [in] | dict | A PDF dictionary that represents the new "MK" dictionary to be set. User should not release this dictionary after setting it to a screen annotation. |
| def fsdk.Screen.SetOpacity | ( | opacity | ) |
Set opacity value.
This property has effect on annotation's appearance. If user wants the effect to be shown in annotation's appearance, please call function fsdk.Annot.ResetAppearanceStream after this function.
| [in] | opacity | The new opacity value. Valid range: 0.0 to 1.0 . 0.0 means full transparency and 1.0 means full opaque. |
| def fsdk.Screen.SetRotation | ( | rotate | ) |
Set the rotation of the image used for the appearance of current screen annotation.
This property has effect on annotation's appearance. If user wants the effect to be shown in annotation's appearance, please call function fsdk.Annot.ResetAppearanceStream after this function.
| [in] | rotate | Rotation value. Please refer to values starting from fsdk.E_Rotation0 and this should be one of these values except fsdk.E_RotationUnknown . |
| def fsdk.Screen.SetTitle | ( | title | ) |
Set title of current screen annotation.
| [in] | title | The title string to be set. |