Class: ActionSubmitForm

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

Extends

• ActionFieldsBase

Constructors

Constructor

new ActionSubmitForm(om, uri?): ActionSubmitForm;

Creates a new ActionSubmitForm.

Parameters

om

ObjectManager

ObjectManager that controls the lifetime of the ActionSubmitForm.

uri?

string

The URL of the script at the Web server that will process the submission.

Returns

ActionSubmitForm

Overrides

ActionFieldsBase.constructor

Constructor

new ActionSubmitForm(uri?): ActionSubmitForm;

Creates a new ActionSubmitForm.

Parameters

uri?

string

The URL of the script at the Web server that will process the submission.

Returns

ActionSubmitForm

Overrides

ActionFieldsBase.constructor

Accessors

canonicalDateFormat

Get Signature

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 Signature

set canonicalDateFormat(value): 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 Signature

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

Set Signature

set excludeSpecifiedFields(value): 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 Signature

get fdfFormat(): FDFFormatFlags;

Gets or sets additional flags used if submitFormat is SubmitFormatType#FDF.

Returns

FDFFormatFlags

Set Signature

set fdfFormat(value): void;

Gets or sets additional flags used if submitFormat is SubmitFormatType#FDF.

Parameters

value

FDFFormatFlags

Returns

void

---

fields

Get Signature

get fields(): (string | Field)[];

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.

See

excludeSpecifiedFields

Returns

(string | Field)[]

Set Signature

set fields(value): 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.

See

excludeSpecifiedFields

Parameters

value

(string | Field)[]

Returns

void

Inherited from

ActionFieldsBase.fields

---

htmlFormFormat

Get Signature

get htmlFormFormat(): HtmlFormFormatFlags;

Gets or sets additional flags used if submitFormat is SubmitFormatType#HtmlForm.

Returns

HtmlFormFormatFlags

Set Signature

set htmlFormFormat(value): void;

Gets or sets additional flags used if submitFormat is SubmitFormatType#HtmlForm.

Parameters

value

HtmlFormFormatFlags

Returns

void

---

id

Get Signature

get id(): number;

Gets the reference to the object.

Returns

number

Inherited from

ActionFieldsBase.id

---

includeFieldsWithNoValue

Get Signature

get includeFieldsWithNoValue(): boolean;

Gets or sets a value indicating whether the fields without a value should be included in request.

Returns

boolean

Set Signature

set includeFieldsWithNoValue(value): 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 Signature

get om(): ObjectManager;

Gets the owner ObjectManager instance.

Returns

ObjectManager

Inherited from

ActionFieldsBase.om

---

pdfFormat

Get Signature

get pdfFormat(): GetMethod;

Gets or sets additional flags used if submitFormat is SubmitFormatType#PDF.

Returns

GetMethod

Set Signature

set pdfFormat(value): void;

Gets or sets additional flags used if submitFormat is SubmitFormatType#PDF.

Parameters

value

GetMethod

Returns

void

---

submitFormat

Get Signature

get submitFormat(): SubmitFormatType;

Gets or sets the format which should be used in request.

Returns

SubmitFormatType

Set Signature

set submitFormat(value): void;

Gets or sets the format which should be used in request.

Parameters

value

SubmitFormatType

Returns

void

---

uri

Get Signature

get uri(): FileSpecification;

Gets or sets the value defining URL of the script at the Web server that will process the submission.

See

• FileSpecification
• FileSpecificationProperties

Returns

FileSpecification

Set Signature

set uri(value): void;

Gets or sets the value defining URL of the script at the Web server that will process the submission.

See

• FileSpecification
• FileSpecificationProperties

Parameters

value

| string | FileSpecification | FileSpecificationProperties

Returns

void

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): 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