foxit.pdf.actions.RemoteGotoAction Class Reference
Inheritance diagram for foxit.pdf.actions.RemoteGotoAction:
foxit.pdf.actions.Action foxit.common.Base

Public Member Functions

 RemoteGotoAction (Action action)
 Constructor, with parent class object.

 
Destination GetDestination ()
 Get the destination information.
More...
 
string GetDestinationName ()
 Get the destination name, which is defined in target PDF file.
More...
 
FileSpec GetFileSpec ()
 Get the file specification which specifies the destination file.
More...
 
Action.NewWindowFlag GetNewWindowFlag ()
 Get the flag which is used to decide whether to open the destination document in a new window or not.
More...
 
void SetDestination (Destination destination)
 Set the destination information, which is used to specify the position in target PDF file to jump to.
More...
 
void SetDestinationName (string dest_name)
 Set the destination name.
More...
 
void SetFileSpec (FileSpec file_specification)
 Set the file specification which specifies the destination file.
More...
 
void SetNewWindowFlag (Action.NewWindowFlag flag)
 Set the flag which is used to decide whether to open the destination document in a new window or not.
More...
 
- Public Member Functions inherited from foxit.pdf.actions.Action
 Action (PDFDoc document, PDFDictionary action_dict)
 Constructor, with parameters.
More...
 
 Action (Action action)
 Constructor, with another action object.

 
PDFDictionary GetDict ()
 Get PDF dictionary of current object.
More...
 
PDFDoc GetDocument ()
 Get the PDF document, to which current action belongs.
More...
 
Action GetSubAction (int index)
 Get a sub-action by index.
More...
 
int GetSubActionCount ()
 Get the count of sub-actions.
More...
 
Action.Type GetType ()
 Get action type.
More...
 
void InsertSubAction (int index, Action sub_action)
 Insert a new sub-action to the location specified by index.
More...
 
bool IsEmpty ()
 Check whether current object is empty or not.
More...
 
void RemoveAllSubActions ()
 Remove all the sub-actions.
More...
 
void RemoveSubAction (int index)
 Remove a sub-action, specified by index.
More...
 
void SetSubAction (int index, Action sub_action)
 Set a sub-action by index.
More...
 

Additional Inherited Members

- Public Types inherited from foxit.pdf.actions.Action
enum  NewWindowFlag { NewWindowFlag.e_NewWindowFlagFalse = 0, NewWindowFlag.e_NewWindowFlagTrue = 1, NewWindowFlag.e_NewWindowFlagNone = 2 }
 Enumeration for new window flag.
More...
 
enum  Type {
  Type.e_TypeUnknown = 0, Type.e_TypeGoto = 1, Type.e_TypeGoToR = 2, Type.e_TypeGoToE = 3,
  Type.e_TypeLaunch = 4, Type.e_TypeThread = 5, Type.e_TypeURI = 6, Type.e_TypeSound = 7,
  Type.e_TypeMovie = 8, Type.e_TypeHide = 9, Type.e_TypeNamed = 10, Type.e_TypeSubmitForm = 11,
  Type.e_TypeResetForm = 12, Type.e_TypeImportData = 13, Type.e_TypeJavaScript = 14, Type.e_TypeSetOCGState = 15,
  Type.e_TypeRendition = 16, Type.e_TypeTrans = 17, Type.e_TypeGoTo3DView = 18
}
 Enumeration for action type.
More...
 
- Static Public Member Functions inherited from foxit.pdf.actions.Action
static Action Create (PDFDoc document, Action.Type action_type)
 Create a new action, for specified action type.
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 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 function 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 function 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 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 function RemoteGotoAction::SetFileSpec and function RemoteGotoAction::SetDestination or 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()

Destination foxit.pdf.actions.RemoteGotoAction.GetDestination ( )
inline

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 it is a Destination object, function RemoteGotoAction::GetDestination would return a valid Destination object.
If it is a destination name, function RemoteGotoAction::GetDestinationName would return a valid string, and the destination name would be defined in the target PDF file.
If the return value of function Destination::IsEmpty for the returned Destination object is true and function 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 Destination::IsEmpty for the returned Destination object is true, please try function RemoteGotoAction::GetDestinationName.

◆ GetDestinationName()

string foxit.pdf.actions.RemoteGotoAction.GetDestinationName ( )
inline

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 it is a Destination object, function RemoteGotoAction::GetDestination would return a valid Destination object.
If it is a destination name, function RemoteGotoAction::GetDestinationName would return a valid string, and the destination name would be defined in the target PDF file.
If the return value of function Destination::IsEmpty for the returned Destination object is true and function 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 RemoteGotoAction::GetDestination.

◆ GetFileSpec()

FileSpec foxit.pdf.actions.RemoteGotoAction.GetFileSpec ( )
inline

Get the file specification which specifies the destination file.

Returns
A non-embedded FileSpec object.

◆ GetNewWindowFlag()

Action.NewWindowFlag foxit.pdf.actions.RemoteGotoAction.GetNewWindowFlag ( )
inline

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:

e_NewWindowFlagTrue means to open the destination document in a new window.
e_NewWindowFlagFalse means to the destination document replaces current document in the same window.
e_NewWindowFlagNone means no such flag and the viewer application should behave in accordance with the current user preference.

◆ SetDestination()

void foxit.pdf.actions.RemoteGotoAction.SetDestination ( Destination  destination)
inline

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

Parameters
destinationA valid Destination object to be set.
Returns
None.

◆ SetDestinationName()

void foxit.pdf.actions.RemoteGotoAction.SetDestinationName ( string  dest_name)
inline

Set the destination name.

The destination name should have been in the "Dests" name tree in the target PDF file.

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

◆ SetFileSpec()

void foxit.pdf.actions.RemoteGotoAction.SetFileSpec ( FileSpec  file_specification)
inline

Set the file specification which specifies the destination file.

Parameters
file_specificationA valid FileSpec 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()

void foxit.pdf.actions.RemoteGotoAction.SetNewWindowFlag ( Action.NewWindowFlag  flag)
inline

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

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

e_NewWindowFlagTrue means to open the destination document in a new window.
e_NewWindowFlagFalse means to the destination document replaces current document in the same window.
e_NewWindowFlagNone means such flag is not needed and the viewer application should behave in accordance with the current user preference.

Returns
None.

Foxit Software Corporation Logo
@2018 Foxit Software Incorporated. All rights reserved.