Foxit PDF SDK
|
Public Member Functions | |
def | RenditionAction (action) |
Constructor, with parent class object. More... | |
def | GetJavaScript () |
Get the JavaScript script to be executed. More... | |
def | GetOperationType () |
Get the operation type of current rendition action when being triggered. More... | |
def | GetRendition (index) |
Get a rendition by index. More... | |
def | GetRenditionCount () |
Get the count of rendition objects. More... | |
def | GetScreenAnnot () |
Get the related screen annotation. More... | |
def | InsertRendition (rendition, index) |
Insert a rendition to current rendition action, at the position specified by index. More... | |
def | RemoveRendition (rendition) |
Remove a rendition object from current rendition action. More... | |
def | SetJavaScript (script) |
Set the JavaScript script to be executed. More... | |
def | SetOperationType (op_type) |
Set the operation type of current rendition action when being triggered. More... | |
def | SetScreenAnnot (screen_annot) |
Set related screen annotation. More... | |
![]() | |
def | Action (document, action_dict) |
Constructor, with parameters. More... | |
def | GetDict () |
Get PDF dictionary of current object. More... | |
def | GetDocument () |
Get the PDF document, to which current action belongs. More... | |
def | GetSubAction (index) |
Get a sub-action by index. More... | |
def | GetSubActionCount () |
Get the count of sub-actions. More... | |
def | GetType () |
Get action type. More... | |
def | InsertSubAction (index, sub_action) |
Insert a new sub-action to the location specified by index. More... | |
def | IsEmpty () |
Check whether current object is empty or not. More... | |
def | RemoveAllSubActions () |
Remove all the sub-actions. More... | |
def | RemoveSubAction (index) |
Remove a sub-action, specified by index. More... | |
def | SetSubAction (index, sub_action) |
Set a sub-action by index. More... | |
Static Public Attributes | |
e_OpTypeAssociate = _fsdk.RenditionAction_e_OpTypeAssociate | |
Associate rendition to related screen annotation. More... | |
e_OpTypeNone = _fsdk.RenditionAction_e_OpTypeNone | |
No operation is specified. | |
e_OpTypePause = _fsdk.RenditionAction_e_OpTypePause | |
Pause any rendition being played in association with related screen annotation. If no rendition is being played, there is no effect. | |
e_OpTypePlay = _fsdk.RenditionAction_e_OpTypePlay | |
Play rendition (which is specified in rendition action), associating it with related screen annotation. If a rendition is already associated with the annotation, resume that rendition if it is paused; otherwise, do nothing. | |
e_OpTypeResume = _fsdk.RenditionAction_e_OpTypeResume | |
Resume any rendition being played in association with related screen annotation. If no rendition is being played or the rendition is not paused, there is no effect. | |
e_OpTypeStop = _fsdk.RenditionAction_e_OpTypeStop | |
Stop any rendition being played in association with related screen annotation and remove the association. If no rendition is being played, there is no effect. | |
![]() | |
Create = _fsdk.Action_Create | |
Create a new action, for specified action type. More... | |
e_NewWindowFlagFalse = _fsdk.Action_e_NewWindowFlagFalse | |
"NewWindow" flag is false. | |
e_NewWindowFlagNone = _fsdk.Action_e_NewWindowFlagNone | |
No "NewWindow" flag. | |
e_NewWindowFlagTrue = _fsdk.Action_e_NewWindowFlagTrue | |
"NewWindow" flag is true. | |
e_TypeGoto = _fsdk.Action_e_TypeGoto | |
Action type: go-to action. | |
e_TypeGoTo3DView = _fsdk.Action_e_TypeGoTo3DView | |
Action type: go-to-3D-view action. | |
e_TypeGoToE = _fsdk.Action_e_TypeGoToE | |
Action type: embedded go-to action. | |
e_TypeGoToR = _fsdk.Action_e_TypeGoToR | |
Action type: remote go-to action. | |
e_TypeHide = _fsdk.Action_e_TypeHide | |
Action type: hide action. | |
e_TypeImportData = _fsdk.Action_e_TypeImportData | |
Action type: import-data action. | |
e_TypeJavaScript = _fsdk.Action_e_TypeJavaScript | |
Action type: JavaScript action. | |
e_TypeLaunch = _fsdk.Action_e_TypeLaunch | |
Action type: launch action. | |
e_TypeMovie = _fsdk.Action_e_TypeMovie | |
Action type: movie action. | |
e_TypeNamed = _fsdk.Action_e_TypeNamed | |
Action type: named action. | |
e_TypeRendition = _fsdk.Action_e_TypeRendition | |
Action type: rendition action. | |
e_TypeResetForm = _fsdk.Action_e_TypeResetForm | |
Action type: reset-form action. | |
e_TypeSetOCGState = _fsdk.Action_e_TypeSetOCGState | |
Action type: set-OCG-state action. | |
e_TypeSound = _fsdk.Action_e_TypeSound | |
Action type: sound action. | |
e_TypeSubmitForm = _fsdk.Action_e_TypeSubmitForm | |
Action type: submit-form action. | |
e_TypeThread = _fsdk.Action_e_TypeThread | |
Action type: thread action. | |
e_TypeTrans = _fsdk.Action_e_TypeTrans | |
Action type: transition action. | |
e_TypeUnknown = _fsdk.Action_e_TypeUnknown | |
Action type: unknown action. | |
e_TypeURI = _fsdk.Action_e_TypeURI | |
Action type: uniform resource identifier (URI) action. | |
Rendition action is to control the playing of multimedia content. (For more details, please refer to <PDF Reference 1.7> P668 "Rendition Actions") Class FoxitPDFSDKPython3.RenditionAction is derived from Action and offers functions to get/set rendition action data.
def FoxitPDFSDKPython3.RenditionAction.RenditionAction | ( | action | ) |
Constructor, with parent class object.
[in] | action | Parent class object. |
def FoxitPDFSDKPython3.RenditionAction.GetJavaScript | ( | ) |
Get the JavaScript script to be executed.
As a useful rendition action, it should contain a JavaScript script to be executed or is specified an operation type to be performed when triggered. If both JavaScript script and operation type exist, application should execute JavaScript; if application is unable to execute JavaScript script, then perform as operation type defines. If no JavaScript script and operation type is invalid, that means the action is invalid.
def FoxitPDFSDKPython3.RenditionAction.GetOperationType | ( | ) |
Get the operation type of current rendition action when being triggered.
As a useful rendition action, it should contain a JavaScript script to be executed or is specified an operation type to be performed when triggered. If both JavaScript script and operation type exist, application should execute JavaScript; if application is unable to execute JavaScript script, then perform as operation type defines. If no JavaScript script and operation type is invalid, that means the action is invalid.
def FoxitPDFSDKPython3.RenditionAction.GetRendition | ( | index | ) |
Get a rendition by index.
[in] | index | Index of rendition object to be retrieved. Valid range: from 0 to (count-1). count is returned by function FoxitPDFSDKPython3.RenditionAction.GetRenditionCount . |
def FoxitPDFSDKPython3.RenditionAction.GetRenditionCount | ( | ) |
Get the count of rendition objects.
def FoxitPDFSDKPython3.RenditionAction.GetScreenAnnot | ( | ) |
Get the related screen annotation.
def FoxitPDFSDKPython3.RenditionAction.InsertRendition | ( | rendition, | |
index | |||
) |
Insert a rendition to current rendition action, at the position specified by index.
Rendition object is necessary for a rendition action when operation type is FoxitPDFSDKPython3.RenditionAction.e_OpTypeAssociate or FoxitPDFSDKPython3.RenditionAction.e_OpTypeAssociate .
[in] | rendition | A rendition object to be inserted. |
[in] | index | Index that specifies where to insert the rendition object. If index is below 0 or bigger than (count-1), the input rendition will be inserted to be the end. count is returned by function FoxitPDFSDKPython3.RenditionAction.GetRenditionCount . |
def FoxitPDFSDKPython3.RenditionAction.RemoveRendition | ( | rendition | ) |
Remove a rendition object from current rendition action.
[in] | rendition | A rendition object to be removed from current rendition action. |
def FoxitPDFSDKPython3.RenditionAction.SetJavaScript | ( | script | ) |
Set the JavaScript script to be executed.
As a useful rendition action, it should contain a JavaScript script to be executed or is specified an operation type to be performed when triggered. If both JavaScript script and operation type exist, application should execute JavaScript; if application is unable to execute JavaScript script, then perform as operation type defines. If no JavaScript script and operation type is invalid, that means the action is invalid.
[in] | script | A JavaScript script to be set. |
def FoxitPDFSDKPython3.RenditionAction.SetOperationType | ( | op_type | ) |
Set the operation type of current rendition action when being triggered.
As a useful rendition action, it should contain a JavaScript script to be executed or is specified an operation type to be performed when triggered. If both JavaScript script and operation type exist, application should execute JavaScript; if application is unable to execute JavaScript script, then perform as operation type defines. If no JavaScript script and operation type is invalid, that means the action is invalid.
[in] | op_type | Operation type. Please refer to values starting from FoxitPDFSDKPython3.RenditionAction.e_OpTypeAssociate and this should be one of these values. If set value FoxitPDFSDKPython3.RenditionAction.e_OpTypeNone , that means no operation type is specified. |
def FoxitPDFSDKPython3.RenditionAction.SetScreenAnnot | ( | screen_annot | ) |
Set related screen annotation.
This property is necessary when operation type is set with valid value.
[in] | screen_annot | A screen annotation object to be set as related screen annotation. |
|
static |
Associate rendition to related screen annotation.
If no rendition is associated with related screen annotation, play rendition (which is specified in rendition action), associating it with the annotation. If a rendition is already associated with related screen annotation, it is stopped, and the new rendition (which is specified in rendition action) is associated with the annotation.