|
Foxit PDF SDK
|
Public Member Functions | |
| 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... | |
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 Action and offers functions to get/set embedded go-to action data.
| def 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.
| def 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.
| def fsdk.EmbeddedGotoAction.GetNewWindowFlag | ( | ) |
Get the flag which is used to decide whether to open the destination document in a new window or not.
| def fsdk.EmbeddedGotoAction.GetRootFile | ( | ) |
Get the file specification of the root file which is the root file for the target.
| def fsdk.EmbeddedGotoAction.GetTarget | ( | ) |
Get the target.
| def 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. |
| def 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. |
| def 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:
|
| def 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:
|
| def 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. |