Foxit PDF SDK
fsdk.URIAction Class Reference

Public Member Functions

def GetURI ()
 Get the URI string.
More...
 
def IsTrackPosition ()
 Check whether to track the mouse position when the URI is resolved.
More...
 
def SetTrackPositionFlag (is_track_position)
 Set the value for tracking position flag.
More...
 
def SetURI (uri)
 Set the URI string.
More...
 

Detailed Description

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

See also
Action

Member Function Documentation

◆ GetURI()

def fsdk.URIAction.GetURI ( )

Get the URI string.

Returns
URI string.

◆ IsTrackPosition()

def fsdk.URIAction.IsTrackPosition ( )

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()

def fsdk.URIAction.SetTrackPositionFlag (   is_track_position)

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()

def fsdk.URIAction.SetURI (   uri)

Set the URI string.

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