Foxit PDF SDK
FSDK.GotoAction Class Reference
Inheritance diagram for FSDK.GotoAction:
FSDK.Action

Public Member Functions

 constructor (action)
 Constructor, with parent class object. More...
 
 GetDestination ()
 Get the destination information. More...
 
 SetDestination (dest)
 Set the destination information. More...
 
- Public Member Functions inherited from FSDK.Action
 constructor (document, action_dict)
 Constructor, with parameters. More...
 
 GetDict ()
 Get PDF dictionary of current object. More...
 
 GetDocument ()
 Get the PDF document, to which current action belongs. More...
 
 GetSubAction (index)
 Get a sub-action by index. More...
 
 GetSubActionCount ()
 Get the count of sub-actions. More...
 
 GetType ()
 Get action type. More...
 
 InsertSubAction (index, sub_action)
 Insert a new sub-action to the location specified by index. More...
 
 IsEmpty ()
 Check whether current object is empty or not. More...
 
 RemoveAllSubActions ()
 Remove all the sub-actions. More...
 
 RemoveSubAction (index)
 Remove a sub-action, specified by index. More...
 
 SetSubAction (index, sub_action)
 Set a sub-action by index. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from FSDK.Action
static Create (document, action_type)
 Create a new action, for specified action type. More...
 
- Static Public Attributes inherited from FSDK.Action
static e_NewWindowFlagFalse
 Enumeration for new window flag. More...
 
static e_NewWindowFlagNone
 No "NewWindow" flag.
 
static e_NewWindowFlagTrue
 "NewWindow" flag is true.
 
static e_TypeGoto
 Action type: go-to action.
 
static e_TypeGoTo3DView
 Action type: go-to-3D-view action.
 
static e_TypeGoToE
 Action type: embedded go-to action.
 
static e_TypeGoToR
 Action type: remote go-to action.
 
static e_TypeHide
 Action type: hide action.
 
static e_TypeImportData
 Action type: import-data action.
 
static e_TypeJavaScript
 Action type: JavaScript action.
 
static e_TypeLaunch
 Action type: launch action.
 
static e_TypeMovie
 Action type: movie action.
 
static e_TypeNamed
 Action type: named action.
 
static e_TypeRendition
 Action type: rendition action.
 
static e_TypeResetForm
 Action type: reset-form action.
 
static e_TypeSetOCGState
 Action type: set-OCG-state action.
 
static e_TypeSound
 Action type: sound action.
 
static e_TypeSubmitForm
 Action type: submit-form action.
 
static e_TypeThread
 Action type: thread action.
 
static e_TypeTrans
 Action type: transition action.
 
static e_TypeUnknown
 Enumeration for action type. More...
 
static e_TypeURI
 Action type: uniform resource identifier (URI) action.
 

Detailed Description

Go-to action is an action that changes the view to a specified destination (page, location, and magnification factor).
Class FSDK.GotoAction is derived from FSDK.Action and offers functions to get/set go-to action data.

See also
FSDK.Action

Member Function Documentation

◆ constructor()

FSDK.GotoAction.constructor ( action  )

Constructor, with parent class object.

Parameters
[in]actionParent class object.

◆ GetDestination()

FSDK.GotoAction.GetDestination ( )

Get the destination information.

Returns
A destination object.

◆ SetDestination()

FSDK.GotoAction.SetDestination ( dest  )

Set the destination information.

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