Foxit PDF SDK
FoxitPDFSDKPython3.RenditionAction Class Reference
Inheritance diagram for FoxitPDFSDKPython3.RenditionAction:
FoxitPDFSDKPython3.Action FoxitPDFSDKPython3.Base

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...
 
- Public Member Functions inherited from FoxitPDFSDKPython3.Action
def Action (action)
 Constructor, with another action object.
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.

 
- Static Public Attributes inherited from FoxitPDFSDKPython3.Action
 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.

 

Additional Inherited Members

- Static Public Member Functions inherited from FoxitPDFSDKPython3.Action
def Create (dictionary)
 Create a new action, for specified action type.
More...
 

Detailed Description

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.

See also
Action

Constructor & Destructor Documentation

◆ RenditionAction()

def FoxitPDFSDKPython3.RenditionAction.RenditionAction (   action)

Constructor, with parent class object.

Parameters
[in]actionParent class object.

Member Function Documentation

◆ GetJavaScript()

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.

Returns
A JavaScript script.

◆ GetOperationType()

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.

Returns
Operation type. Please refer to values starting from FoxitPDFSDKPython3.RenditionAction.e_OpTypeNone and this would be one of these values.

◆ GetRendition()

def FoxitPDFSDKPython3.RenditionAction.GetRendition (   index)

Get a rendition by index.

Parameters
[in]indexIndex of rendition object to be retrieved. Valid range: from 0 to (count-1). count is returned by function FoxitPDFSDKPython3.RenditionAction.GetRenditionCount .
Returns
A rendition object.

◆ GetRenditionCount()

def FoxitPDFSDKPython3.RenditionAction.GetRenditionCount ( )

Get the count of rendition objects.

Returns
The count of rendition objects.

◆ GetScreenAnnot()

def FoxitPDFSDKPython3.RenditionAction.GetScreenAnnot ( )

Get the related screen annotation.

Returns
A screen annotation object.

◆ InsertRendition()

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 .

Parameters
[in]renditionA rendition object to be inserted.
[in]indexIndex 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 .
Returns
None.

◆ RemoveRendition()

def FoxitPDFSDKPython3.RenditionAction.RemoveRendition (   rendition)

Remove a rendition object from current rendition action.

Parameters
[in]renditionA rendition object to be removed from current rendition action.
Returns
None.

◆ SetJavaScript()

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.

Parameters
[in]scriptA JavaScript script to be set.
Returns
None.

◆ SetOperationType()

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.

Parameters
[in]op_typeOperation 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.
Returns
None.

◆ SetScreenAnnot()

def FoxitPDFSDKPython3.RenditionAction.SetScreenAnnot (   screen_annot)

Set related screen annotation.

This property is necessary when operation type is set with valid value.

Parameters
[in]screen_annotA screen annotation object to be set as related screen annotation.
Returns
None.

Member Data Documentation

◆ e_OpTypeAssociate

FoxitPDFSDKPython3.RenditionAction.e_OpTypeAssociate = _fsdk.RenditionAction_e_OpTypeAssociate
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.