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

Public Member Functions

 constructor (action)
 Constructor, with parent class object. More...
 
 GetFieldNames ()
 Get all field names from the array of current reset form action. More...
 
 GetFlags ()
 Get the flag value used for resetting. More...
 
 SetFieldNames (field_names)
 Set field name array. More...
 
 SetFlags (flags)
 Set the flag value used for resetting. 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

Reset-form action is to set fields to their default values Class FSDK.ResetFormAction is derived from FSDK.Action and offers functions to get/set reset-form action data.

See also
FSDK.Action

Member Function Documentation

◆ constructor()

FSDK.ResetFormAction.constructor ( action  )

Constructor, with parent class object.

Parameters
[in]actionParent class object.

◆ GetFieldNames()

FSDK.ResetFormAction.GetFieldNames ( )

Get all field names from the array of current reset form action.

A reset form action can have an array identifying which fields to reset or to exclude from resetting, depending on the flag value.

Returns
An array of field names.

◆ GetFlags()

FSDK.ResetFormAction.GetFlags ( )

Get the flag value used for resetting.

Returns
Flag value. Currently, the value would be :
  • 0: means to reset fields defined in the array.
  • 1: means to reset all fields except those defined in the array.

◆ SetFieldNames()

FSDK.ResetFormAction.SetFieldNames ( field_names  )

Set field name array.

A reset form action can have an array identifying which fields to reset or to exclude from resetting, depending on the flag value.

Parameters
[in]field_namesAn array of form fields' names, to identify which fields to reset or to exclude from resetting. Field name can be retrieved by function FSDK.Field.GetName.
Returns
None.

◆ SetFlags()

FSDK.ResetFormAction.SetFlags ( flags  )

Set the flag value used for resetting.

Parameters
[in]flagsFlag value. Currently, valid values are:
  • 0: means to reset fields defined in the array.
  • 1: means to reset all fields except those defined in the array.
Returns
None.