Foxit PDF SDK
fsdk.EmbeddedGotoAction Class Reference

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

Detailed Description

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.

See also
Action

Member Function Documentation

◆ GetDestination()

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.

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

◆ GetDestinationName()

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.

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

◆ GetNewWindowFlag()

def fsdk.EmbeddedGotoAction.GetNewWindowFlag ( )

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

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

◆ GetRootFile()

def fsdk.EmbeddedGotoAction.GetRootFile ( )

Get the file specification of the root file which is the root file for the target.

Returns
A non-embedded file specification object. If the return value of function fsdk.FileSpec.IsEmpty for the returned file specification object is true, that means the PDF file which contains current embedded goto action is just the root file for target object.

◆ GetTarget()

def fsdk.EmbeddedGotoAction.GetTarget ( )

Get the target.

Returns
An embedded goto target object. If the return value of function fsdk.EmbeddedGotoTarget.IsEmpty for the returned embedded goto target object is true, that means no target.

◆ SetDestination()

def fsdk.EmbeddedGotoAction.SetDestination (   destination)

Set the destination information which specifies where to jump to in the final target file.

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

◆ SetDestinationName()

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.

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

◆ SetNewWindowFlag()

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.

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

Returns
None.

◆ SetRootFile()

def fsdk.EmbeddedGotoAction.SetRootFile (   file_specification)

Set the file specification of the root file which is the root file for the target.

Parameters
[in]file_specificationThe file specification object:
  • It can be constructed by default constructor and not set any value. In this case, that means the PDF file which contains current embedded goto action is also the root file for target.
  • Otherwise, this should be a valid file specification object, and should represent another file, not an embedded file. The file specification object should be in the same PDF file as current action.

Returns
None.

◆ SetTarget()

def fsdk.EmbeddedGotoAction.SetTarget (   target)

Set the target.

Parameters
[in]targetAn embedded goto target object. If this is constructed by default constructor and has not been set any value, that means no target.
Returns
None.