Foxit PDF SDK
|
Public Member Functions | |
def | EmbeddedGotoAction (action) |
Constructor, with parent class object. More... | |
def | GetDestination () |
Get the destination information which specifies where to jump to in the final target file. More... | |
def | GetDestinationName () |
Get the destination name which is defined in final target PDF file. More... | |
def | GetNewWindowFlag () |
Get the flag which is used to decide whether to open the destination document in a new window or not. More... | |
def | GetRootFile () |
Get the file specification of the root file which is the root file for the target. More... | |
def | GetTarget () |
Get the target. More... | |
def | SetDestination (destination) |
Set the destination information which specifies where to jump to in the final target file. More... | |
def | SetDestinationName (dest_name) |
Set the destination name. More... | |
def | SetNewWindowFlag (flag) |
Set the flag which is used to decide whether to open the destination document in a new window or not. More... | |
def | SetRootFile (file_specification) |
Set the file specification of the root file which is the root file for the target. More... | |
def | SetTarget (target) |
Set the target. More... | |
![]() | |
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... | |
Additional Inherited Members | |
![]() | |
def | Create (dictionary) |
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. | |
Embedded go-to action is similar to a remote go-to action but allows jumping to or from a PDF file that is embedded in another PDF file. Class FoxitPDFSDKPython3.EmbeddedGotoTarget is derived from Action and offers functions to get/set embedded go-to action data.
def FoxitPDFSDKPython3.EmbeddedGotoAction.EmbeddedGotoAction | ( | action | ) |
Constructor, with parent class object.
[in] | action | Parent class object. |
def FoxitPDFSDKPython3.EmbeddedGotoAction.GetDestination | ( | ) |
Get the destination information which specifies where to jump to in the final target file.
For a embedded go-to action, the destination information can be stored as either a destination object or a destination name:
If the return value of function FoxitPDFSDKPython3.Destination.IsEmpty for the returned destination object is true and function FoxitPDFSDKPython3.EmbeddedGotoAction.GetDestinationName returns an empty string, that means the embedded go-to action does not have any destination information.
def FoxitPDFSDKPython3.EmbeddedGotoAction.GetDestinationName | ( | ) |
Get the destination name which is defined in final target PDF file.
For a remote go-to action, the destination information can be stored as either a destination object or a destination name:
If the return value of function FoxitPDFSDKPython3.Destination.IsEmpty for the returned destination object is true and function FoxitPDFSDKPython3.EmbeddedGotoAction.GetDestinationName returns an empty string, that means the embedded go-to action does not have any destination information.
def FoxitPDFSDKPython3.EmbeddedGotoAction.GetNewWindowFlag | ( | ) |
Get the flag which is used to decide whether to open the destination document in a new window or not.
def FoxitPDFSDKPython3.EmbeddedGotoAction.GetRootFile | ( | ) |
Get the file specification of the root file which is the root file for the target.
def FoxitPDFSDKPython3.EmbeddedGotoAction.GetTarget | ( | ) |
Get the target.
def FoxitPDFSDKPython3.EmbeddedGotoAction.SetDestination | ( | destination | ) |
Set the destination information which specifies where to jump to in the final target file.
[in] | destination | A valid destination object to be set. |
def FoxitPDFSDKPython3.EmbeddedGotoAction.SetDestinationName | ( | dest_name | ) |
Set the destination name.
The destination name should have been in the "Dests" name tree in the target PDF file.
[in] | dest_name | A destination name to be set. It should not be an empty string. |
def FoxitPDFSDKPython3.EmbeddedGotoAction.SetNewWindowFlag | ( | flag | ) |
Set the flag which is used to decide whether to open the destination document in a new window or not.
[in] | flag | The new window flag. It should be one of following values:
|
def FoxitPDFSDKPython3.EmbeddedGotoAction.SetRootFile | ( | file_specification | ) |
Set the file specification of the root file which is the root file for the target.
[in] | file_specification | The file specification object:
|
def FoxitPDFSDKPython3.EmbeddedGotoAction.SetTarget | ( | target | ) |
Set the target.
[in] | target | An embedded goto target object. If this is constructed by default constructor and has not been set any value, that means no target. |