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

Public Member Functions

def ResetFormAction (action)
 Constructor, with parent class object. More...
 
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...
 
- Public Member Functions inherited from FoxitPDFSDKPython3.Action
def Action (document, action_dict)
 Constructor, with parameters. More...
 
def GetDict ()
 Get PDF dictionary of current object. More...
 
def GetDocument ()
 Get the PDF document, to which current action belongs. More...
 
def GetSubAction (index)
 Get a sub-action by index. More...
 
def GetSubActionCount ()
 Get the count of sub-actions. More...
 
def GetType ()
 Get action type. More...
 
def InsertSubAction (index, sub_action)
 Insert a new sub-action to the location specified by index. More...
 
def IsEmpty ()
 Check whether current object is empty or not. More...
 
def RemoveAllSubActions ()
 Remove all the sub-actions. More...
 
def RemoveSubAction (index)
 Remove a sub-action, specified by index. More...
 
def SetSubAction (index, sub_action)
 Set a sub-action by index. More...
 

Additional Inherited Members

- Static Public Attributes inherited from FoxitPDFSDKPython3.Action
 Create = _fsdk.Action_Create
 Create a new action, for specified action type. More...
 
 e_NewWindowFlagFalse = _fsdk.Action_e_NewWindowFlagFalse
 "NewWindow" flag is false.
 
 e_NewWindowFlagNone = _fsdk.Action_e_NewWindowFlagNone
 No "NewWindow" flag.
 
 e_NewWindowFlagTrue = _fsdk.Action_e_NewWindowFlagTrue
 "NewWindow" flag is true.
 
 e_TypeGoto = _fsdk.Action_e_TypeGoto
 Action type: go-to action.
 
 e_TypeGoTo3DView = _fsdk.Action_e_TypeGoTo3DView
 Action type: go-to-3D-view action.
 
 e_TypeGoToE = _fsdk.Action_e_TypeGoToE
 Action type: embedded go-to action.
 
 e_TypeGoToR = _fsdk.Action_e_TypeGoToR
 Action type: remote go-to action.
 
 e_TypeHide = _fsdk.Action_e_TypeHide
 Action type: hide action.
 
 e_TypeImportData = _fsdk.Action_e_TypeImportData
 Action type: import-data action.
 
 e_TypeJavaScript = _fsdk.Action_e_TypeJavaScript
 Action type: JavaScript action.
 
 e_TypeLaunch = _fsdk.Action_e_TypeLaunch
 Action type: launch action.
 
 e_TypeMovie = _fsdk.Action_e_TypeMovie
 Action type: movie action.
 
 e_TypeNamed = _fsdk.Action_e_TypeNamed
 Action type: named action.
 
 e_TypeRendition = _fsdk.Action_e_TypeRendition
 Action type: rendition action.
 
 e_TypeResetForm = _fsdk.Action_e_TypeResetForm
 Action type: reset-form action.
 
 e_TypeSetOCGState = _fsdk.Action_e_TypeSetOCGState
 Action type: set-OCG-state action.
 
 e_TypeSound = _fsdk.Action_e_TypeSound
 Action type: sound action.
 
 e_TypeSubmitForm = _fsdk.Action_e_TypeSubmitForm
 Action type: submit-form action.
 
 e_TypeThread = _fsdk.Action_e_TypeThread
 Action type: thread action.
 
 e_TypeTrans = _fsdk.Action_e_TypeTrans
 Action type: transition action.
 
 e_TypeUnknown = _fsdk.Action_e_TypeUnknown
 Action type: unknown action.
 
 e_TypeURI = _fsdk.Action_e_TypeURI
 Action type: uniform resource identifier (URI) action.
 

Detailed Description

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

See also
Action

Constructor & Destructor Documentation

◆ ResetFormAction()

def FoxitPDFSDKPython3.ResetFormAction.ResetFormAction (   action)

Constructor, with parent class object.

Parameters
[in]actionParent class object.

Member Function Documentation

◆ GetFieldNames()

def FoxitPDFSDKPython3.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 FoxitPDFSDKPython3.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 FoxitPDFSDKPython3.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 FoxitPDFSDKPython3.Field.GetName .
Returns
None.

◆ SetFlags()

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