Foxit PDF SDK
fsdk.SubmitFormAction Class Reference

Public Member Functions

def GetFieldNames ()
 Get all field names from the array in current submit form action.
More...
 
def GetFlags ()
 Get the flag value used for submission.
More...
 
def GetURL ()
 Get the URI string of the script at the Web server that will process the submission.
More...
 
def SetFieldNames (field_names)
 Set field name array.
More...
 
def SetFlags (flags)
 Set the flag value used for submission.
More...
 
def SetURL (url)
 Set the URI string of the script at the Web server that will process the submission.
More...
 

Detailed Description

Submit-form action is to send data to a uniform resource locator. Class fsdk.SubmitFormAction is derived from Action and offers functions to get/set submit-form action data.

See also
Action

Member Function Documentation

◆ GetFieldNames()

def fsdk.SubmitFormAction.GetFieldNames ( )

Get all field names from the array in current submit form action.

A submit form action can have an array identifying which fields to include in the submission or which to exclude, depending on the flag value.

Returns
An array of field names.

◆ GetFlags()

def fsdk.SubmitFormAction.GetFlags ( )

Get the flag value used for submission.

Returns
Flag value. Please refer to values starting from fsdk.SubmitFormActionE_FlagExclude and this would be one or a combination of these values. 0 means all bits in the flag are 0.

◆ GetURL()

def fsdk.SubmitFormAction.GetURL ( )

Get the URI string of the script at the Web server that will process the submission.

Returns
URI string.

◆ SetFieldNames()

def fsdk.SubmitFormAction.SetFieldNames (   field_names)

Set field name array.

A submit form action can have an array identifying which fields to include in the submission or which to exclude, depending on the flag value.

Parameters
[in]field_namesAn array of form fields' names, to identify which fields to include in or exclude from submission. This parameter can be an empty array. Field name can be retrieved by function fsdk.Field.GetName .
Returns
None.

◆ SetFlags()

def fsdk.SubmitFormAction.SetFlags (   flags)

Set the flag value used for submission.

Parameters
[in]flagsNew flag value. Please refer to values starting from fsdk.SubmitFormActionE_FlagExclude and this can be one or a combination of these values It could also be 0, which means all bits in the flag are 0.
Returns
None.

◆ SetURL()

def fsdk.SubmitFormAction.SetURL (   url)

Set the URI string of the script at the Web server that will process the submission.

Parameters
[in]urlURI string. It should not be an empty string.
Returns
None.