Foxit PDF SDK
fsdk.ResetFormAction Class Reference

Public Member Functions

def GetFieldNames ()
 Get all field names from the array of current reset form action. More...
 
def GetFlags ()
 Get the flag value used for resetting. More...
 
def SetFieldNames (field_names)
 Set field name array. More...
 
def SetFlags (flags)
 Set the flag value used for resetting. More...
 

Detailed Description

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

See also
Action

Member Function Documentation

◆ GetFieldNames()

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

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

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

def 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.