|
Foxit PDF SDK
|
Public Member Functions | |
| RenditionAction (Action action) | |
| Constructor, with parent class object. More... | |
| string | GetJavaScript () |
| Get the JavaScript script to be executed. More... | |
| RenditionAction.OperationType | GetOperationType () |
| Get the operation type of current rendition action when being triggered. More... | |
| Rendition | GetRendition (int index) |
| Get a rendition by index. More... | |
| int | GetRenditionCount () |
| Get the count of rendition objects. More... | |
| Screen | GetScreenAnnot () |
| Get the related screen annotation. More... | |
| void | InsertRendition (Rendition rendition, int index) |
| Insert a rendition to current rendition action, at the position specified by index. More... | |
| void | RemoveRendition (Rendition rendition) |
| Remove a rendition object from current rendition action. More... | |
| void | SetJavaScript (string script) |
| Set the JavaScript script to be executed. More... | |
| void | SetOperationType (RenditionAction.OperationType op_type) |
| Set the operation type of current rendition action when being triggered. More... | |
| void | SetScreenAnnot (Screen screen_annot) |
| Set related screen annotation. More... | |
Public Member Functions inherited from foxit.pdf.actions.Action | |
| Action (Action action) | |
| Constructor, with another action object. More... | |
| Action (PDFDoc document, PDFDictionary action_dict) | |
| Constructor, with parameters. More... | |
| PDFDictionary | GetDict () |
| Get PDF dictionary of current object. More... | |
| PDFDoc | GetDocument () |
| Get the PDF document, to which current action belongs. More... | |
| Action | GetSubAction (int index) |
| Get a sub-action by index. More... | |
| int | GetSubActionCount () |
| Get the count of sub-actions. More... | |
| Action.Type | GetType () |
| Get action type. More... | |
| void | InsertSubAction (int index, Action sub_action) |
| Insert a new sub-action to the location specified by index. More... | |
| bool | IsEmpty () |
| Check whether current object is empty or not. More... | |
| void | RemoveAllSubActions () |
| Remove all the sub-actions. More... | |
| void | RemoveSubAction (int index) |
| Remove a sub-action, specified by index. More... | |
| void | SetSubAction (int index, Action sub_action) |
| Set a sub-action by index. More... | |
Additional Inherited Members | |
Static Public Member Functions inherited from foxit.pdf.actions.Action | |
| static Action | Create (PDFDoc document, Action.Type action_type) |
| Create a new action, for specified action type. More... | |
Rendition action is to control the playing of multimedia content. (For more details, please refer to <PDF Reference 1.7> P668 "Rendition Actions") Class foxit.pdf.actions.RenditionAction is derived from Action and offers functions to get/set rendition action data.
|
strong |
Enumeration for operation type to perform when the rendition action is triggered.
Values of this enumeration should be used alone.
|
inline |
Constructor, with parent class object.
| [in] | action | Parent class object. |
|
inline |
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.
|
inline |
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.
|
inline |
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 RenditionAction.GetRenditionCount . |
|
inline |
Get the count of rendition objects.
|
inline |
Get the related screen annotation.
|
inline |
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 foxit.pdf.actions.RenditionAction.OperationType.e_OpTypeAssociate or foxit.pdf.actions.RenditionAction.OperationType.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 RenditionAction.GetRenditionCount . |
|
inline |
Remove a rendition object from current rendition action.
| [in] | rendition | A rendition object to be removed from current rendition action. |
|
inline |
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. |
|
inline |
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 foxit.pdf.actions.RenditionAction.OperationType.e_OpTypeAssociate and this should be one of these values. If set value foxit.pdf.actions.RenditionAction.OperationType.e_OpTypeNone , that means no operation type is specified. |
|
inline |
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. |