# ActionSubmitForm

## Content

# Class: ActionSubmitForm

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

## Extends

- [`ActionFieldsBase`](ActionFieldsBase)

## Constructors

### Constructor

```ts
new ActionSubmitForm(om, uri?): ActionSubmitForm;
```

Creates a new ActionSubmitForm.

#### Parameters

##### om

[`ObjectManager`](ObjectManager)

[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

```ts
ActionFieldsBase.constructor
```

### Constructor

```ts
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

```ts
ActionFieldsBase.constructor
```

## Accessors

### canonicalDateFormat

#### Get Signature

```ts
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

```ts
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

```ts
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

```ts
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`](ActionFieldsBase).[`excludeSpecifiedFields`](ActionFieldsBase#excludespecifiedfields)

***

### fdfFormat

#### Get Signature

```ts
get fdfFormat(): FDFFormatFlags;
```

Gets or sets additional flags used if [submitFormat](#submitformat) is [SubmitFormatType#FDF](../enumerations/SubmitFormatType#fdf).

##### Returns

[`FDFFormatFlags`](../enumerations/FDFFormatFlags)

#### Set Signature

```ts
set fdfFormat(value): void;
```

Gets or sets additional flags used if [submitFormat](#submitformat) is [SubmitFormatType#FDF](../enumerations/SubmitFormatType#fdf).

##### Parameters

###### value

[`FDFFormatFlags`](../enumerations/FDFFormatFlags)

##### Returns

`void`

***

### fields

#### Get Signature

```ts
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](Field) object itself.
An empty list means that all fields are included.

##### See

[excludeSpecifiedFields](ActionFieldsBase#excludespecifiedfields)

##### Returns

(`string` \| [`Field`](Field))[]

#### Set Signature

```ts
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](Field) object itself.
An empty list means that all fields are included.

##### See

[excludeSpecifiedFields](ActionFieldsBase#excludespecifiedfields)

##### Parameters

###### value

(`string` \| [`Field`](Field))[]

##### Returns

`void`

#### Inherited from

[`ActionFieldsBase`](ActionFieldsBase).[`fields`](ActionFieldsBase#fields)

***

### htmlFormFormat

#### Get Signature

```ts
get htmlFormFormat(): HtmlFormFormatFlags;
```

Gets or sets additional flags used if [submitFormat](#submitformat) is [SubmitFormatType#HtmlForm](../enumerations/SubmitFormatType#htmlform).

##### Returns

[`HtmlFormFormatFlags`](../enumerations/HtmlFormFormatFlags)

#### Set Signature

```ts
set htmlFormFormat(value): void;
```

Gets or sets additional flags used if [submitFormat](#submitformat) is [SubmitFormatType#HtmlForm](../enumerations/SubmitFormatType#htmlform).

##### Parameters

###### value

[`HtmlFormFormatFlags`](../enumerations/HtmlFormFormatFlags)

##### Returns

`void`

***

### id

#### Get Signature

```ts
get id(): number;
```

Gets the reference to the object.

##### Returns

`number`

#### Inherited from

[`ActionFieldsBase`](ActionFieldsBase).[`id`](ActionFieldsBase#id)

***

### includeFieldsWithNoValue

#### Get Signature

```ts
get includeFieldsWithNoValue(): boolean;
```

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

##### Returns

`boolean`

#### Set Signature

```ts
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

```ts
get om(): ObjectManager;
```

Gets the owner [ObjectManager](ObjectManager) instance.

##### Returns

[`ObjectManager`](ObjectManager)

#### Inherited from

[`ActionFieldsBase`](ActionFieldsBase).[`om`](ActionFieldsBase#om)

***

### pdfFormat

#### Get Signature

```ts
get pdfFormat(): GetMethod;
```

Gets or sets additional flags used if [submitFormat](#submitformat) is [SubmitFormatType#PDF](../enumerations/SubmitFormatType#pdf).

##### Returns

[`GetMethod`](../enumerations/PDFFormatFlags#getmethod)

#### Set Signature

```ts
set pdfFormat(value): void;
```

Gets or sets additional flags used if [submitFormat](#submitformat) is [SubmitFormatType#PDF](../enumerations/SubmitFormatType#pdf).

##### Parameters

###### value

[`GetMethod`](../enumerations/PDFFormatFlags#getmethod)

##### Returns

`void`

***

### submitFormat

#### Get Signature

```ts
get submitFormat(): SubmitFormatType;
```

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

##### Returns

[`SubmitFormatType`](../enumerations/SubmitFormatType)

#### Set Signature

```ts
set submitFormat(value): void;
```

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

##### Parameters

###### value

[`SubmitFormatType`](../enumerations/SubmitFormatType)

##### Returns

`void`

***

### uri

#### Get Signature

```ts
get uri(): FileSpecification;
```

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

##### See

 - [FileSpecification](FileSpecification)
 - [FileSpecificationProperties](../type-aliases/FileSpecificationProperties)

##### Returns

[`FileSpecification`](FileSpecification)

#### Set Signature

```ts
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](FileSpecification)
 - [FileSpecificationProperties](../type-aliases/FileSpecificationProperties)

##### Parameters

###### value

  \| `string`
  \| [`FileSpecification`](FileSpecification)
  \| [`FileSpecificationProperties`](../type-aliases/FileSpecificationProperties)

##### Returns

`void`

## Methods

### free()

```ts
free(): void;
```

Detaches the object from the [ObjectManager](ObjectManager) and deallocates its memory, if possible.

#### Returns

`void`

#### Inherited from

[`ActionFieldsBase`](ActionFieldsBase).[`free`](ActionFieldsBase#free)

***

### rebind()

```ts
rebind(omTo): void;
```

Rebinds the object from the current [ObjectManager](ObjectManager) to the specified one.

#### Parameters

##### omTo

[`ObjectManager`](ObjectManager)

The new [ObjectManager](ObjectManager) for the object.

#### Returns

`void`

#### Inherited from

[`ActionFieldsBase`](ActionFieldsBase).[`rebind`](ActionFieldsBase#rebind)