Class ActionSubmitForm

Represents an action that causes a script to be compiled and executed by the JavaScript interpreter.

Hierarchy (View Summary)

ActionFieldsBase
- ActionSubmitForm

Index

Constructors

Accessors

canonicalDateFormat excludeSpecifiedFields fdfFormat fields htmlFormFormat id includeFieldsWithNoValue om pdfFormat submitFormat uri

Methods

free rebind

Constructors

constructor

new ActionSubmitForm(om: ObjectManager, uri?: string): ActionSubmitForm
Creates a new ActionSubmitForm.
Parameters
- om: ObjectManager
  ObjectManager that controls the lifetime of the ActionSubmitForm.
- Optionaluri: string
  The URL of the script at the Web server that will process the submission.
Returns ActionSubmitForm
Overrides ActionFieldsBase.constructor
new ActionSubmitForm(uri?: string): ActionSubmitForm
Creates a new ActionSubmitForm.
Parameters
- Optionaluri: string
  The URL of the script at the Web server that will process the submission.
Returns ActionSubmitForm
Overrides ActionFieldsBase.constructor

Accessors

canonicalDateFormat

get canonicalDateFormat(): boolean
Gets or sets a value indicating whether any submitted field values representing dates are converted to the standard format described in PDF specification.

Returns boolean
set canonicalDateFormat(value: boolean): void
Gets or sets a value indicating whether any submitted field values representing dates are converted to the standard format described in PDF specification.
Parameters
- value: boolean
Returns void

excludeSpecifiedFields

get excludeSpecifiedFields(): boolean
Gets or sets a value indicating whether the fields specified by the 'fields' list should be excluded for processing. By default this property is "false", which means that the fields in the list are processed. If this property is set to "true", the fields in the list are excluded from processing.

Returns boolean
Inherited from ActionFieldsBase.excludeSpecifiedFields
set excludeSpecifiedFields(value: boolean): void
Gets or sets a value indicating whether the fields specified by the 'fields' list should be excluded for processing. By default this property is "false", which means that the fields in the list are processed. If this property is set to "true", the fields in the list are excluded from processing.
Parameters
- value: boolean
Returns void
Inherited from ActionFieldsBase.excludeSpecifiedFields

fdfFormat

get fdfFormat(): FDFFormatFlags
Gets or sets additional flags used if submitFormat is SubmitFormatType#FDF.

Returns FDFFormatFlags
set fdfFormat(value: FDFFormatFlags): void
Gets or sets additional flags used if submitFormat is SubmitFormatType#FDF.
Parameters
- value: FDFFormatFlags
Returns void

fields

get fields(): (string | Field)[] | null
Gets the list of fields that should be processed or excluded from processing (depending on the value of 'excludeSpecifiedFields') by this action. An item in this list can be either a field's name specified as a "string", or the Field object itself. An empty list means that all fields are included.

Returns (string | Field)[] | null
See
excludeSpecifiedFields

Inherited from ActionFieldsBase.fields
set fields(value: (string | Field)[] | null): void
Gets the list of fields that should be processed or excluded from processing (depending on the value of 'excludeSpecifiedFields') by this action. An item in this list can be either a field's name specified as a "string", or the Field object itself. An empty list means that all fields are included.
Parameters
- value: (string | Field)[] | null
Returns void
See
excludeSpecifiedFields

Inherited from ActionFieldsBase.fields

htmlFormFormat

get htmlFormFormat(): HtmlFormFormatFlags
Gets or sets additional flags used if submitFormat is SubmitFormatType#HtmlForm.

Returns HtmlFormFormatFlags
set htmlFormFormat(value: HtmlFormFormatFlags): void
Gets or sets additional flags used if submitFormat is SubmitFormatType#HtmlForm.
Parameters
- value: HtmlFormFormatFlags
Returns void

id

get id(): number
Gets the reference to the object.

Returns number
Inherited from ActionFieldsBase.id

includeFieldsWithNoValue

get includeFieldsWithNoValue(): boolean
Gets or sets a value indicating whether the fields without a value should be included in request.

Returns boolean
set includeFieldsWithNoValue(value: boolean): void
Gets or sets a value indicating whether the fields without a value should be included in request.
Parameters
- value: boolean
Returns void

om

get om(): ObjectManager
Gets the owner ObjectManager instance.

Returns ObjectManager
Inherited from ActionFieldsBase.om

pdfFormat

get pdfFormat(): GetMethod
Gets or sets additional flags used if submitFormat is SubmitFormatType#PDF.

Returns GetMethod
set pdfFormat(value: GetMethod): void
Gets or sets additional flags used if submitFormat is SubmitFormatType#PDF.
Parameters
- value: GetMethod
Returns void

submitFormat

get submitFormat(): SubmitFormatType
Gets or sets the format which should be used in request.

Returns SubmitFormatType
set submitFormat(value: SubmitFormatType): void
Gets or sets the format which should be used in request.
Parameters
- value: SubmitFormatType
Returns void

uri

get uri(): FileSpecification | null
Gets or sets the value defining URL of the script at the Web server that will process the submission.

Returns FileSpecification | null
See
- FileSpecification
- FileSpecificationProperties
set uri(
value: string | FileSpecificationProperties | FileSpecification | null,
): void
Gets or sets the value defining URL of the script at the Web server that will process the submission.
Parameters
- value: string | FileSpecificationProperties | FileSpecification | null
Returns void
See
- FileSpecification
- FileSpecificationProperties

Methods

free

free(): void
Detaches the object from the ObjectManager and deallocates its memory, if possible.

Returns void
Inherited from ActionFieldsBase.free

rebind

rebind(omTo: ObjectManager): void
Rebinds the object from the current ObjectManager to the specified one.
Parameters
- omTo: ObjectManager
  The new ObjectManager for the object.
Returns void
Inherited from ActionFieldsBase.rebind

Class ActionSubmitForm

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns ActionSubmitForm

Parameters

Returns ActionSubmitForm

Accessors

canonicalDateFormat

Returns boolean

Parameters

Returns void

excludeSpecifiedFields

Returns boolean

Parameters

Returns void

fdfFormat

Returns FDFFormatFlags

Parameters

Returns void

fields

Returns (string | Field)[] | null

See

Parameters

Returns void

See

htmlFormFormat

Returns HtmlFormFormatFlags

Parameters

Returns void

id

Returns number

includeFieldsWithNoValue

Returns boolean

Parameters

Returns void

om

Returns ObjectManager

pdfFormat

Returns GetMethod

Parameters

Returns void

submitFormat

Returns SubmitFormatType

Parameters

Returns void

uri

Returns FileSpecification | null

See

Parameters

Returns void

See

Methods

free

Returns void

rebind

Parameters

Returns void

Settings

On This Page