FoxitPDFSDKforWeb  v10.0.0
Foxit PDF SDK for Web
Action Class Reference

PDF action object. More...

Inheritance diagram for Action:
EmbeddedGotoAction GoToAction HideAction JavaScriptAction LaunchAction LaunchAction ResetFormAction SubmitFormAction SubmitFormAction URIAction

Public Member Functions

 getSubAction (index)
 Get a sub-action by index. More...
 
 getSubActionCount ()
 Get the count of sub-actions. More...
 
 getType ()
 Get action type. More...
 
 insertSubAction (index, action)
 Insert a new sub-action to the location specified by index. More...
 
 removeAllSubActions ()
 Remove all the sub-actions. More...
 
 removeSubAction (index)
 Remove a sub-action, specified by index. More...
 
 setSubAction (index, action)
 Set a sub-action by index. More...
 

Detailed Description

PDF action object.

Member Function Documentation

◆ getSubAction()

Action::getSubAction (   index)
inline

Get a sub-action by index.

Parameters
indexnumber - Index of sub-action to be retrieved. Valid range: from 0 to (count-1).
Returns
Action - An action object that represents the specified sub-action.

◆ getSubActionCount()

Action::getSubActionCount ( )
inline

Get the count of sub-actions.

Returns
number - Count of sub-actions.

◆ getType()

Action::getType ( )
inline

Get action type.

Returns
string - Action type.

◆ insertSubAction()

Action::insertSubAction (   index,
  action 
)
inline

Insert a new sub-action to the location specified by index.

Parameters
indexnumber - Index of the location, where the new sub-action is inserted.
actionAction - New action to be set. It should be valid.
Returns
Promise<object> - An action object.

◆ removeAllSubActions()

Action::removeAllSubActions ( )
inline

Remove all the sub-actions.

Returns
Promise<void> -

◆ removeSubAction()

Action::removeSubAction (   index)
inline

Remove a sub-action, specified by index.

Parameters
indexnumber - Index of sub-action to be retrieved. Valid range: from 0 to (count-1).
Returns
Promise<void> -

◆ setSubAction()

Action::setSubAction (   index,
  action 
)
inline

Set a sub-action by index.

Parameters
indexnumber - Index of sub-action to be retrieved. Valid range: from 0 to (count-1).
actionAction - New action to be set. It should be valid.
Returns
Promise<object> - An action object.

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