Foxit PDF SDK
|
Public Member Functions | |
constructor (action) | |
Constructor, with parent class object. More... | |
GetDestination () | |
Get the destination information which specifies where to jump to in the final target file. More... | |
GetDestinationName () | |
Get the destination name which is defined in final target PDF file. More... | |
GetNewWindowFlag () | |
Get the flag which is used to decide whether to open the destination document in a new window or not. More... | |
GetRootFile () | |
Get the file specification of the root file which is the root file for the target. More... | |
GetTarget () | |
Get the target. More... | |
SetDestination (destination) | |
Set the destination information which specifies where to jump to in the final target file. More... | |
SetDestinationName (dest_name) | |
Set the destination name. More... | |
SetNewWindowFlag (flag) | |
Set the flag which is used to decide whether to open the destination document in a new window or not. More... | |
SetRootFile (file_specification) | |
Set the file specification of the root file which is the root file for the target. More... | |
SetTarget (target) | |
Set the target. More... | |
![]() | |
constructor (document, action_dict) | |
Constructor, with parameters. More... | |
GetDict () | |
Get PDF dictionary of current object. More... | |
GetDocument () | |
Get the PDF document, to which current action belongs. More... | |
GetSubAction (index) | |
Get a sub-action by index. More... | |
GetSubActionCount () | |
Get the count of sub-actions. More... | |
GetType () | |
Get action type. More... | |
InsertSubAction (index, sub_action) | |
Insert a new sub-action to the location specified by index. More... | |
IsEmpty () | |
Check whether current object is empty or not. More... | |
RemoveAllSubActions () | |
Remove all the sub-actions. More... | |
RemoveSubAction (index) | |
Remove a sub-action, specified by index. More... | |
SetSubAction (index, sub_action) | |
Set a sub-action by index. More... | |
Additional Inherited Members | |
![]() | |
static | Create (document, action_type) |
Create a new action, for specified action type. More... | |
![]() | |
static | e_NewWindowFlagFalse |
Enumeration for new window flag. More... | |
static | e_NewWindowFlagNone |
No "NewWindow" flag. | |
static | e_NewWindowFlagTrue |
"NewWindow" flag is true. | |
static | e_TypeGoto |
Action type: go-to action. | |
static | e_TypeGoTo3DView |
Action type: go-to-3D-view action. | |
static | e_TypeGoToE |
Action type: embedded go-to action. | |
static | e_TypeGoToR |
Action type: remote go-to action. | |
static | e_TypeHide |
Action type: hide action. | |
static | e_TypeImportData |
Action type: import-data action. | |
static | e_TypeJavaScript |
Action type: JavaScript action. | |
static | e_TypeLaunch |
Action type: launch action. | |
static | e_TypeMovie |
Action type: movie action. | |
static | e_TypeNamed |
Action type: named action. | |
static | e_TypeRendition |
Action type: rendition action. | |
static | e_TypeResetForm |
Action type: reset-form action. | |
static | e_TypeSetOCGState |
Action type: set-OCG-state action. | |
static | e_TypeSound |
Action type: sound action. | |
static | e_TypeSubmitForm |
Action type: submit-form action. | |
static | e_TypeThread |
Action type: thread action. | |
static | e_TypeTrans |
Action type: transition action. | |
static | e_TypeUnknown |
Enumeration for action type. More... | |
static | 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 FSDK.EmbeddedGotoTarget is derived from FSDK.Action and offers functions to get/set embedded go-to action data.
FSDK.EmbeddedGotoAction.constructor | ( | action | ) |
Constructor, with parent class object.
[in] | action | Parent class object. |
FSDK.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 FSDK.Destination.IsEmpty for the returned destination object is true and function FSDK.EmbeddedGotoAction.GetDestinationName returns an empty string, that means the embedded go-to action does not have any destination information.
FSDK.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 FSDK.Destination.IsEmpty for the returned destination object is true and function FSDK.EmbeddedGotoAction.GetDestinationName returns an empty string, that means the embedded go-to action does not have any destination information.
FSDK.EmbeddedGotoAction.GetNewWindowFlag | ( | ) |
Get the flag which is used to decide whether to open the destination document in a new window or not.
FSDK.EmbeddedGotoAction.GetRootFile | ( | ) |
Get the file specification of the root file which is the root file for the target.
FSDK.EmbeddedGotoAction.GetTarget | ( | ) |
Get the target.
FSDK.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. |
FSDK.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. |
FSDK.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:
|
FSDK.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:
|
FSDK.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. |