|
Foxit PDF SDK
|
Public Member Functions | |
| def | GetDestination () |
| Get the destination information. More... | |
| def | GetDestinationName () |
| Get the destination name, which is defined in target PDF file. More... | |
| def | GetFileSpec () |
| Get the file specification which specifies the destination 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 | SetDestination (destination) |
| Set the destination information, which is used to specify the position in target PDF file to jump to. More... | |
| def | SetDestinationName (dest_name) |
| Set the destination name. More... | |
| def | SetFileSpec (file_specification) |
| Set the file specification which specifies the destination file. 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... | |
Remote go-to action is similar to an ordinary go-to action but jumps to a destination in another PDF file (not embedded file) instead of current PDF file (which contains the remote go-to action).
Class fsdk.RemoteGotoAction is derived from Action and offers functions to get/set remote go-to action data. Destination information of a remote go-to action can be represents as either a destination array or a destination name:
Destination PDF file and destination information are necessary for a remote go-to action, so user should ensure to set both data by fsdk.RemoteGotoAction.SetFileSpec and fsdk.RemoteGotoAction.SetDestination or fsdk.RemoteGotoAction.SetDestinationName , especially for a new remote go-to action; otherwise, the remote go-to action would be useless.
| def fsdk.RemoteGotoAction.GetDestination | ( | ) |
Get the destination information.
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.RemoteGotoAction.GetDestinationName returns an empty string, that means the remote go-to action does not have any destination information.
| def fsdk.RemoteGotoAction.GetDestinationName | ( | ) |
Get the destination name, which is defined in 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.RemoteGotoAction.GetDestinationName returns an empty string, that means the remote go-to action does not have any destination information.
| def fsdk.RemoteGotoAction.GetFileSpec | ( | ) |
Get the file specification which specifies the destination file.
| def fsdk.RemoteGotoAction.GetNewWindowFlag | ( | ) |
Get the flag which is used to decide whether to open the destination document in a new window or not.
| def fsdk.RemoteGotoAction.SetDestination | ( | destination | ) |
Set the destination information, which is used to specify the position in target PDF file to jump to.
| [in] | destination | A valid destination object to be set. |
| def fsdk.RemoteGotoAction.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 be not be an empty string. |
| def fsdk.RemoteGotoAction.SetFileSpec | ( | file_specification | ) |
Set the file specification which specifies the destination file.
| [in] | file_specification | A valid file specification object to be set. This object should belong to the same PDF file as current action. It should represent another PDF file as the target file, and should not represent an embedded file. |
| def fsdk.RemoteGotoAction.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:
|