Foxit PDF SDK
foxit.pdf.actions.URIAction Class Reference
Inheritance diagram for foxit.pdf.actions.URIAction:
foxit.pdf.actions.Action foxit.common.Base

Public Member Functions

 URIAction (Action action)
 Constructor, with parent class object. More...
 
string GetURI ()
 Get the URI string. More...
 
bool IsTrackPosition ()
 Check whether to track the mouse position when the URI is resolved. More...
 
void SetTrackPositionFlag (bool is_track_position)
 Set the value for tracking position flag. More...
 
void SetURI (string uri)
 Set the URI string. 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. More...
 
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

URI (uniform resource identifier) action is an action that causes a URI to be resolved. Class foxit.pdf.actions.URIAction is derived from Action and offers functions to get/set URI action data.

See also
Action

Constructor & Destructor Documentation

◆ URIAction()

foxit.pdf.actions.URIAction.URIAction ( Action  action)
inline

Constructor, with parent class object.

Parameters
[in]actionParent class object.

Member Function Documentation

◆ GetURI()

string foxit.pdf.actions.URIAction.GetURI ( )
inline

Get the URI string.

Returns
URI string.

◆ IsTrackPosition()

bool foxit.pdf.actions.URIAction.IsTrackPosition ( )
inline

Check whether to track the mouse position when the URI is resolved.

Returns
true means application should track the mouse position, while false means no need to track the mouse position.

◆ SetTrackPositionFlag()

void foxit.pdf.actions.URIAction.SetTrackPositionFlag ( bool  is_track_position)
inline

Set the value for tracking position flag.

Parameters
[in]is_track_positiontrue means to track position, while false means not to track position.
Returns
None.

◆ SetURI()

void foxit.pdf.actions.URIAction.SetURI ( string  uri)
inline

Set the URI string.

Parameters
[in]uriA URI string to be set. It should not be an empty string.
Returns
None.