Foxit PDF SDK
fsdk.RemoteGotoAction Class Reference

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...
 

Detailed Description

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:

  • If the destination information is a destination array, Foxit PDF SDK uses a destination object to represent it and fsdk.RemoteGotoAction.GetDestination can be used to get such value.
  • If the destination information is a destination name, Foxit PDF SDK uses a string to represent it and fsdk.RemoteGotoAction.GetDestinationName can be used to get such value. Specially, the related destination array is defined in the target PDF file, not current PDF file. User can use functions in class fsdk.PDFNameTree to retrieve the actual destination array from target PDF file.

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.

See also
Action

Member Function Documentation

◆ GetDestination()

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.

Returns
A destination object. If the return value of function fsdk.Destination.IsEmpty for the returned destination object is true, please try function fsdk.RemoteGotoAction.GetDestinationName .

◆ GetDestinationName()

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.

Returns
The destination name. If this function returns an empty string, please try function fsdk.RemoteGotoAction.GetDestination .

◆ GetFileSpec()

def fsdk.RemoteGotoAction.GetFileSpec ( )

Get the file specification which specifies the destination file.

Returns
A non-embedded file specification object.

◆ GetNewWindowFlag()

def fsdk.RemoteGotoAction.GetNewWindowFlag ( )

Get the flag which is used to decide whether to open the destination document in a new window or not.

Returns
The new window flag. It would be one of following values:

◆ SetDestination()

def fsdk.RemoteGotoAction.SetDestination (   destination)

Set the destination information, which is used to specify the position in target PDF file to jump to.

Parameters
[in]destinationA valid destination object to be set.
Returns
None.

◆ SetDestinationName()

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.

Parameters
[in]dest_nameA destination name to be set. It should be not be an empty string.
Returns
None.

◆ SetFileSpec()

def fsdk.RemoteGotoAction.SetFileSpec (   file_specification)

Set the file specification which specifies the destination file.

Parameters
[in]file_specificationA 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.
Returns
None.

◆ SetNewWindowFlag()

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.

Parameters
[in]flagThe new window flag. It should be one of following values:

Returns
None.