Reference NutrientViewer ActionsSubmitFormAction

Class SubmitFormAction

PDF action to submit form fields in the current document.

It is an immutable object and thus can be updated using set(key, value), for example: action.set("uri", "www.nutrient.io");.

A SubmitFormAction defines which form fields should be submitted, when clicked on it. The form field names and their values will get submitted to the provided URI defined by the uri field. By default all form fields will be submitted. The includeExclude field defines if the fields specified by fields, which are a NutrientViewer.Immutable.List of form field names, should submit all form fields excluding the defined fields or just the defined fields. When includeExclude is set to true, all form fields except the fields defined in fields will be submitted. If includeExclude is set to false, which is the default value for this field, only the form fields defined in fields will be submitted.

Class

Example

Create a new SubmitFormAction

const action = new NutrientViewer.Actions.SubmitFormAction({
  uri: "www.nutrient.io"
});

Hierarchy

ReadonlyActionSubmitFormAction

Constructors

new SubmitFormAction(args)

Parameters
args
{ … }{
    canonicalFormat?: boolean;
    embedForm?: boolean;
    excludeFKey?: boolean;
    excludeNonUserAnnotations?: boolean;
    exportFormat?: boolean;
    getMethod?: boolean;
    includeAnnotations?: boolean;
    includeAppendSaves?: boolean;
    includeExclude?: boolean;
    includeNoValueFields?: boolean;
    submitCoordinated?: boolean;
    submitPDF?: boolean;
    uri?: string;
    xfdf?: boolean;
    fields?: NutrientViewer.Immutable.List<string> | null;
    subActions?:
        | NutrientViewer.Immutable.List<
            NutrientViewer.Actions.Action<(ActionProperties), (ActionProperties)>,
        >
        | null;
}
Optional
Inherited from Action.constructor

Properties

canonicalFormat

Readonly

boolean

This option is not supported yet. If true, any submitted field values representing dates shall be converted to the standard format.

Default Value

false

embedForm

Readonly

boolean

This option is not supported yet. shall be used only when the form is being submitted in Forms Data Format (that is, when both the XFDF and ExportFormat flags are false). If true, the F entry of the submitted FDF shall be a file specification containing an embedded file stream representing the PDF file from which the FDF is being submitted.

Default Value

false

excludeFKey

Readonly

boolean

Default Value

false

excludeNonUserAnnotations

Readonly

boolean

This option is not supported yet. shall be used only when the form is being submitted in Forms Data Format (that is, when both the XFDF and ExportFormat flags are false) and the IncludeAnnotations flag is true. If true, it shall include only those markup annotations those T entry matches the name of the current user, as determined by the remote server to which the form is being submitted.

Default Value

false

exportFormat

Readonly

boolean

Meaningful only if the submitPDF and xfdf flags are false. If set, field names and values shall be submitted in HTML Form format. If false, they shall be submitted in Forms Data Format (FDF)

Default Value

true

fields

Readonly

NutrientViewer.Immutable.List<string> | null | undefined

A List identifying which fields to submit or which to exclude from submitting, depending on the setting of the includeExclude flag. Each element of the array shall be a text string representing the fully qualified name of a field. If this entry is omitted, the includeExclude flag shall be ignored; all fields in the document’s interactive form are submitted.

Default Value

null

getMethod

Readonly

boolean

If true, field names and values shall be submitted using an HTTP GET request. If false, they shall be submitted using a POST request. This flag is meaningful only when the exportFormat flag is set. If exportFormat is false, this flag shall also be false.

Default Value

false

includeAnnotations

Readonly

boolean

This option is not supported yet. shall be used only when the form is being submitted in Forms Data Format (that is, when both the XFDF and ExportFormat flags are false). If set, the submitted FDF file shall include all markup annotations in the underlying PDF document. If false, markup annotations shall not be included.

Default Value

false

includeAppendSaves

Readonly

boolean

This option is not supported yet. Shall be used only when the form is being submitted in Forms Data Format (that is, when both the XFDF and ExportFormat flags are false). If true, the submitted FDF file shall include the contents of all incremental updates to the underlying PDF document, as contained in the Differences entry in the FDF dictionary. If false, the incremental updates shall not be included.

Default Value

false

includeExclude

Readonly

boolean

If false, the fields list specifies which fields to submit. If true, the fields list indicates which fields to exclude from submitting. That is, all fields in the document’s interactive form shall be submitted except those listed in the fields list.

Default Value

false

includeNoValueFields

Readonly

boolean

This option is not supported yet. If true, all fields designated by the Fields array and the IncludeExclude flag shall be submitted, regardless of whether they have a value. For fields without a value, only the field name shall be transmitted. If false, fields without a value shall not be submitted.

Default Value

true

subActions

OptionalReadonly

NutrientViewer.Immutable.List<NutrientViewer.Actions.Action> | null

Actions can be chained by adding them to this immutable List.

submitCoordinated

Readonly

boolean

This option is not supported yet. If true, the coordinates of the mouse click that caused the submit-form action shall be transmitted as part of the form data. The coordinate values are relative to the upper-left corner of the field’s widget annotation rectangle. They shall be represented in the data in the format name.x=xval&name.y=yval where name is the field’s name.

Default Value

false

submitPDF

Readonly

boolean

If true, the document shall be submitted as PDF, using the MIME content type application/pdf.

Default Value

false

uri

Readonly

string

The uniform resource identifier (web link) defining where the form should be submitted to, when this action got triggered.

xfdf

Readonly

boolean

This option is not supported yet. Shall be used only if the SubmitPDF flags are false. If true, field names and values shall be submitted as XFDF.

Default Value

false

Methods

entries

entries(): IterableIterator<[string, unknown]>
Returns the record's [key, value] pairs, in the order its fields were defined.

Returns
IterableIterator<[string, unknown]>
An iterator over the record's fields.

Inherited from Action.entries

Immutable Record API

[iterator]

"[iterator]"(): IterableIterator<[string, unknown]>
Iterates the record's [key, value] pairs, in the order its fields were defined.

Returns
IterableIterator<[string, unknown]>
Inherited from Action.[iterator]

clear

clear(): this
Returns a record with every key reset to the default it was defined with.

Returns
this
A new record holding only default values.

Inherited from Action.clear

delete

delete<K extends keyof { … }>(
    key: K & (
        | "uri"
        | "includeExclude"
        | "includeNoValueFields"
        | "exportFormat"
        | "getMethod"
        | "submitCoordinated"
        | "xfdf"
        | "includeAppendSaves"
        | "includeAnnotations"
        | "submitPDF"
        | "canonicalFormat"
        | "excludeNonUserAnnotations"
        | "excludeFKey"
        | "embedForm"
        | "fields"
        | "subActions"
    ),
): thisdelete<
    K extends
        keyof {
            canonicalFormat: boolean;
            embedForm: boolean;
            excludeFKey: boolean;
            excludeNonUserAnnotations: boolean;
            exportFormat: boolean;
            getMethod: boolean;
            includeAnnotations: boolean;
            includeAppendSaves: boolean;
            includeExclude: boolean;
            includeNoValueFields: boolean;
            submitCoordinated: boolean;
            submitPDF: boolean;
            uri: string;
            xfdf: boolean;
            fields: NutrientViewer.Immutable.List<string>
            | null
            | undefined;
            subActions?:
                | NutrientViewer.Immutable.List<
                    NutrientViewer.Actions.Action<
                        (ActionProperties),
                        (ActionProperties),
                    >,
                >
                | null;
        },
>(
    key: K & (
        | "uri"
        | "includeExclude"
        | "includeNoValueFields"
        | "exportFormat"
        | "getMethod"
        | "submitCoordinated"
        | "xfdf"
        | "includeAppendSaves"
        | "includeAnnotations"
        | "submitPDF"
        | "canonicalFormat"
        | "excludeNonUserAnnotations"
        | "excludeFKey"
        | "embedForm"
        | "fields"
        | "subActions"
    ),
): this
Returns a record with key reset to the default it was defined with.

Type Parameters
K
extends keyof { … }extends keyof {
    canonicalFormat: boolean;
    embedForm: boolean;
    excludeFKey: boolean;
    excludeNonUserAnnotations: boolean;
    exportFormat: boolean;
    getMethod: boolean;
    includeAnnotations: boolean;
    includeAppendSaves: boolean;
    includeExclude: boolean;
    includeNoValueFields: boolean;
    submitCoordinated: boolean;
    submitPDF: boolean;
    uri: string;
    xfdf: boolean;
    fields: NutrientViewer.Immutable.List<string> | null | undefined;
    subActions?:
        | NutrientViewer.Immutable.List<
            NutrientViewer.Actions.Action<(ActionProperties), (ActionProperties)>,
        >
        | null;
}
Parameters
keyK & (
| "uri"
| "includeExclude"
| "includeNoValueFields"
| "exportFormat"
| "getMethod"
| "submitCoordinated"
| "xfdf"
| "includeAppendSaves"
| "includeAnnotations"
| "submitPDF"
| "canonicalFormat"
| "excludeNonUserAnnotations"
| "excludeFKey"
| "embedForm"
| "fields"
| "subActions"
)
One of the keys this record was defined with.

Returns
this
A new record, or this one when the value already equals the default.

Inherited from Action.delete

deleteIn

deleteIn(keyPath: Iterable<unknown>): this
Returns a record with the value at keyPath removed. A field of this record is reset to its default; a key of a nested collection or plain object is deleted.

Parameters
keyPathIterable<unknown>
The keys to follow, outermost first.

Returns
this
A new record, or this one when nothing was removed.

Inherited from Action.deleteIn

equals

Deprecated

equals(other: unknown): boolean
Reports whether other is a record holding the same keys with equal values, whatever its class.

Parameters
otherunknown
The value to compare against.

Returns
boolean
true when both hold the same keys and every value matches.

Deprecated
Records of different classes with identical values compare equal. Use isEqual(), which also requires both records to be of the same class.

Inherited from Action.equals

get

get<K extends keyof { … }, N = never>(
    key: K & (
        | "uri"
        | "includeExclude"
        | "includeNoValueFields"
        | "exportFormat"
        | "getMethod"
        | "submitCoordinated"
        | "xfdf"
        | "includeAppendSaves"
        | "includeAnnotations"
        | "submitPDF"
        | "canonicalFormat"
        | "excludeNonUserAnnotations"
        | "excludeFKey"
        | "embedForm"
        | "fields"
        | "subActions"
    ),
    notSetValue?: N,
): N | { … }[K]get<
    K extends
        keyof {
            canonicalFormat: boolean;
            embedForm: boolean;
            excludeFKey: boolean;
            excludeNonUserAnnotations: boolean;
            exportFormat: boolean;
            getMethod: boolean;
            includeAnnotations: boolean;
            includeAppendSaves: boolean;
            includeExclude: boolean;
            includeNoValueFields: boolean;
            submitCoordinated: boolean;
            submitPDF: boolean;
            uri: string;
            xfdf: boolean;
            fields: NutrientViewer.Immutable.List<string>
            | null
            | undefined;
            subActions?:
                | NutrientViewer.Immutable.List<
                    NutrientViewer.Actions.Action<
                        (ActionProperties),
                        (ActionProperties),
                    >,
                >
                | null;
        },
    N = never,
>(
    key: K & (
        | "uri"
        | "includeExclude"
        | "includeNoValueFields"
        | "exportFormat"
        | "getMethod"
        | "submitCoordinated"
        | "xfdf"
        | "includeAppendSaves"
        | "includeAnnotations"
        | "submitPDF"
        | "canonicalFormat"
        | "excludeNonUserAnnotations"
        | "excludeFKey"
        | "embedForm"
        | "fields"
        | "subActions"
    ),
    notSetValue?: N,
):
    | N
    | {
        canonicalFormat: boolean;
        embedForm: boolean;
        excludeFKey: boolean;
        excludeNonUserAnnotations: boolean;
        exportFormat: boolean;
        getMethod: boolean;
        includeAnnotations: boolean;
        includeAppendSaves: boolean;
        includeExclude: boolean;
        includeNoValueFields: boolean;
        submitCoordinated: boolean;
        submitPDF: boolean;
        uri: string;
        xfdf: boolean;
        fields: NutrientViewer.Immutable.List<string>
        | null
        | undefined;
        subActions?:
            | NutrientViewer.Immutable.List<
                NutrientViewer.Actions.Action<(ActionProperties), (ActionProperties)>,
            >
            | null;
    }[K]
Returns the value stored under key.

Type Parameters
K
extends keyof { … }extends keyof {
    canonicalFormat: boolean;
    embedForm: boolean;
    excludeFKey: boolean;
    excludeNonUserAnnotations: boolean;
    exportFormat: boolean;
    getMethod: boolean;
    includeAnnotations: boolean;
    includeAppendSaves: boolean;
    includeExclude: boolean;
    includeNoValueFields: boolean;
    submitCoordinated: boolean;
    submitPDF: boolean;
    uri: string;
    xfdf: boolean;
    fields: NutrientViewer.Immutable.List<string> | null | undefined;
    subActions?:
        | NutrientViewer.Immutable.List<
            NutrientViewer.Actions.Action<(ActionProperties), (ActionProperties)>,
        >
        | null;
}
N = never
Parameters
keyK & (
| "uri"
| "includeExclude"
| "includeNoValueFields"
| "exportFormat"
| "getMethod"
| "submitCoordinated"
| "xfdf"
| "includeAppendSaves"
| "includeAnnotations"
| "submitPDF"
| "canonicalFormat"
| "excludeNonUserAnnotations"
| "excludeFKey"
| "embedForm"
| "fields"
| "subActions"
)
One of the keys this record was defined with.

notSetValueN
Optional
Returned when the record does not define key.

Returns
N | { … }[K]
    | N
    | {
        canonicalFormat: boolean;
        embedForm: boolean;
        excludeFKey: boolean;
        excludeNonUserAnnotations: boolean;
        exportFormat: boolean;
        getMethod: boolean;
        includeAnnotations: boolean;
        includeAppendSaves: boolean;
        includeExclude: boolean;
        includeNoValueFields: boolean;
        submitCoordinated: boolean;
        submitPDF: boolean;
        uri: string;
        xfdf: boolean;
        fields: NutrientViewer.Immutable.List<string>
        | null
        | undefined;
        subActions?:
            | NutrientViewer.Immutable.List<
                NutrientViewer.Actions.Action<(ActionProperties), (ActionProperties)>,
            >
            | null;
    }[K]
The current value for that key.

Inherited from Action.get

getIn

getIn(keyPath: Iterable<unknown>): unknown
Returns the value at keyPath, walking nested records and collections.

A literal key path is checked against the record's fields and gives the value's type; a computed one gives unknown.

Parameters
keyPathIterable<unknown>
The keys to follow, outermost first.

Returns
unknown
The value at that path, or undefined when it does not resolve.

Inherited from Action.getIn
getIn<N>(keyPath: Iterable<unknown>, notSetValue: N): unknown
Returns the value at keyPath, walking nested records and collections.

A literal key path is checked against the record's fields and gives the value's type; a computed one gives unknown.

Type Parameters
N
Parameters
keyPathIterable<unknown>
The keys to follow, outermost first.

notSetValueN
Returned when the path does not resolve.

Returns
unknown
The value at that path, or notSetValue.

Inherited from Action.getIn

has

has(
    key: string,
): key is
    | "uri"
    | "includeExclude"
    | "includeNoValueFields"
    | "exportFormat"
    | "getMethod"
    | "submitCoordinated"
    | "xfdf"
    | "includeAppendSaves"
    | "includeAnnotations"
    | "submitPDF"
    | "canonicalFormat"
    | "excludeNonUserAnnotations"
    | "excludeFKey"
    | "embedForm"
    | "fields"
    | "subActions"
Reports whether key is one of the keys this record was defined with.

A literal key must name a field; a key typed as string is narrowed to the field names.

Parameters
keystring
The key to look for.

Returns
key is
| "uri"
| "includeExclude"
| "includeNoValueFields"
| "exportFormat"
| "getMethod"
| "submitCoordinated"
| "xfdf"
| "includeAppendSaves"
| "includeAnnotations"
| "submitPDF"
| "canonicalFormat"
| "excludeNonUserAnnotations"
| "excludeFKey"
| "embedForm"
| "fields"
| "subActions"
true when the record defines that key, even if its value is null.

Inherited from Action.has

hashCode

hashCode(): number
Computes a hash of this record from its contents, the same way Immutable.js does. Equal records have equal hashes; records with equal hashes are not necessarily equal. Plain objects, functions and symbols hash by identity, so a hash is only meaningful within the page that computed it.

Returns
number
An integer hash.

Inherited from Action.hashCode

hasIn

hasIn(keyPath: Iterable<unknown>): boolean
Reports whether keyPath resolves, walking nested records and collections.

Parameters
keyPathIterable<unknown>
The keys to follow, outermost first.

Returns
boolean
true when every key along the path is present.

Inherited from Action.hasIn

isEqual

isEqual(other: unknown): boolean
Reports whether other is a record of the same class holding equal values. Only the two records' own classes are compared; nested records compare as equals() does.

Parameters
otherunknown
The value to compare against.

Returns
boolean
true when both are the same class and every value matches.

Inherited from Action.isEqual

merge

merge(
    ...collections: (Partial<{ … }> | Iterable<readonly [string, unknown]>)[],
): thismerge(
    ...collections: (
        | Partial<
            {
                canonicalFormat: boolean;
                embedForm: boolean;
                excludeFKey: boolean;
                excludeNonUserAnnotations: boolean;
                exportFormat: boolean;
                getMethod: boolean;
                includeAnnotations: boolean;
                includeAppendSaves: boolean;
                includeExclude: boolean;
                includeNoValueFields: boolean;
                submitCoordinated: boolean;
                submitPDF: boolean;
                uri: string;
                xfdf: boolean;
                fields: NutrientViewer.Immutable.List<string>
                | null
                | undefined;
                subActions?:
                    | NutrientViewer.Immutable.List<
                        NutrientViewer.Actions.Action<
                            (ActionProperties),
                            (ActionProperties),
                        >,
                    >
                    | null;
            },
        >
        | Iterable<readonly [string, unknown]>
    )[],
): this
Returns a record with the entries of each collection applied in order.

Keys the record was not defined with are ignored.

Parameters
...collections
(Partial<{ … }> | Iterable<readonly [string, unknown]>)[](
    | Partial<
        {
            canonicalFormat: boolean;
            embedForm: boolean;
            excludeFKey: boolean;
            excludeNonUserAnnotations: boolean;
            exportFormat: boolean;
            getMethod: boolean;
            includeAnnotations: boolean;
            includeAppendSaves: boolean;
            includeExclude: boolean;
            includeNoValueFields: boolean;
            submitCoordinated: boolean;
            submitPDF: boolean;
            uri: string;
            xfdf: boolean;
            fields: NutrientViewer.Immutable.List<string>
            | null
            | undefined;
            subActions?:
                | NutrientViewer.Immutable.List<
                    NutrientViewer.Actions.Action<
                        (ActionProperties),
                        (ActionProperties),
                    >,
                >
                | null;
        },
    >
    | Iterable<readonly [string, unknown]>
)[]
Plain objects or key/value iterables to apply.

Returns
this
A new record, or this one when no value changed.

Inherited from Action.merge

mergeDeep

mergeDeep(
    ...collections: (Partial<{ … }> | Iterable<readonly [string, unknown]>)[],
): thismergeDeep(
    ...collections: (
        | Partial<
            {
                uri: string;
                includeExclude: boolean;
                includeNoValueFields: boolean;
                exportFormat: boolean;
                getMethod: boolean;
                submitCoordinated: boolean;
                xfdf: boolean;
                includeAppendSaves: boolean;
                includeAnnotations: boolean;
                submitPDF: boolean;
                canonicalFormat: boolean;
                excludeNonUserAnnotations: boolean;
                excludeFKey: boolean;
                embedForm: boolean;
                fields: NutrientViewer.Immutable.List<string>
                | null
                | undefined;
                subActions?:
                    | NutrientViewer.Immutable.List<
                        NutrientViewer.Actions.Action<
                            (ActionProperties),
                            (ActionProperties),
                        >,
                    >
                    | null;
            },
        >
        | Iterable<readonly [string, unknown]>
    )[],
): this
Returns a record with the entries of each collection merged in, recursing into nested collections and plain objects instead of replacing them.

Keys the record was not defined with are ignored.

Parameters
...collections
(Partial<{ … }> | Iterable<readonly [string, unknown]>)[](
    | Partial<
        {
            uri: string;
            includeExclude: boolean;
            includeNoValueFields: boolean;
            exportFormat: boolean;
            getMethod: boolean;
            submitCoordinated: boolean;
            xfdf: boolean;
            includeAppendSaves: boolean;
            includeAnnotations: boolean;
            submitPDF: boolean;
            canonicalFormat: boolean;
            excludeNonUserAnnotations: boolean;
            excludeFKey: boolean;
            embedForm: boolean;
            fields: NutrientViewer.Immutable.List<string>
            | null
            | undefined;
            subActions?:
                | NutrientViewer.Immutable.List<
                    NutrientViewer.Actions.Action<
                        (ActionProperties),
                        (ActionProperties),
                    >,
                >
                | null;
        },
    >
    | Iterable<readonly [string, unknown]>
)[]
Plain objects or key/value iterables to merge in.

Returns
this
A new record, or this one when no value changed.

Inherited from Action.mergeDeep

mergeDeepIn

mergeDeepIn(keyPath: Iterable<unknown>, ...collections: unknown[]): this
Returns a record with each collection merged deeply into the value at keyPath.

Parameters
keyPathIterable<unknown>
The keys to follow, outermost first.

...collectionsunknown[]
Collections or plain objects to merge into the value there.

Returns
this
A new record, or this one when the value is unchanged.

Inherited from Action.mergeDeepIn

mergeDeepWith

mergeDeepWith(
    merger: (previous: unknown, next: unknown, key: unknown) => unknown,
    ...collections: (Partial<{ … }> | Iterable<readonly [string, unknown]>)[],
): thismergeDeepWith(
    merger: (previous: unknown, next: unknown, key: unknown) => unknown,
    ...collections: (
        | Partial<
            {
                uri: string;
                includeExclude: boolean;
                includeNoValueFields: boolean;
                exportFormat: boolean;
                getMethod: boolean;
                submitCoordinated: boolean;
                xfdf: boolean;
                includeAppendSaves: boolean;
                includeAnnotations: boolean;
                submitPDF: boolean;
                canonicalFormat: boolean;
                excludeNonUserAnnotations: boolean;
                excludeFKey: boolean;
                embedForm: boolean;
                fields: NutrientViewer.Immutable.List<string>
                | null
                | undefined;
                subActions?:
                    | NutrientViewer.Immutable.List<
                        NutrientViewer.Actions.Action<
                            (ActionProperties),
                            (ActionProperties),
                        >,
                    >
                    | null;
            },
        >
        | Iterable<readonly [string, unknown]>
    )[],
): this
Returns a record with the entries of each collection merged in deeply, calling merger where a nested value is not a collection to decide the value that is kept.

Keys the record was not defined with are ignored.

Parameters
merger(previous: unknown, next: unknown, key: unknown) => unknown
Receives the current value, the incoming value and the key.

...collections
(Partial<{ … }> | Iterable<readonly [string, unknown]>)[](
    | Partial<
        {
            uri: string;
            includeExclude: boolean;
            includeNoValueFields: boolean;
            exportFormat: boolean;
            getMethod: boolean;
            submitCoordinated: boolean;
            xfdf: boolean;
            includeAppendSaves: boolean;
            includeAnnotations: boolean;
            submitPDF: boolean;
            canonicalFormat: boolean;
            excludeNonUserAnnotations: boolean;
            excludeFKey: boolean;
            embedForm: boolean;
            fields: NutrientViewer.Immutable.List<string>
            | null
            | undefined;
            subActions?:
                | NutrientViewer.Immutable.List<
                    NutrientViewer.Actions.Action<
                        (ActionProperties),
                        (ActionProperties),
                    >,
                >
                | null;
        },
    >
    | Iterable<readonly [string, unknown]>
)[]
Plain objects or key/value iterables to merge in.

Returns
this
A new record, or this one when no value changed.

Inherited from Action.mergeDeepWith

mergeIn

mergeIn(keyPath: Iterable<unknown>, ...collections: unknown[]): this
Returns a record with each collection merged into the value at keyPath, one level at a time.

Parameters
keyPathIterable<unknown>
The keys to follow, outermost first.

...collectionsunknown[]
Collections or plain objects to merge into the value there.

Returns
this
A new record, or this one when the value is unchanged.

Inherited from Action.mergeIn

mergeWith

mergeWith(
    merger: <K extends string | number | symbol>(
        previous: { … }[K],
        next: { … }[K],
        key: K,
    ) => { … }[K],
    ...collections: (Partial<{ … }> | Iterable<readonly [string, unknown]>)[],
): thismergeWith(
    merger: <K extends string | number | symbol>(
        previous: {
            canonicalFormat: boolean;
            embedForm: boolean;
            excludeFKey: boolean;
            excludeNonUserAnnotations: boolean;
            exportFormat: boolean;
            getMethod: boolean;
            includeAnnotations: boolean;
            includeAppendSaves: boolean;
            includeExclude: boolean;
            includeNoValueFields: boolean;
            submitCoordinated: boolean;
            submitPDF: boolean;
            uri: string;
            xfdf: boolean;
            fields: NutrientViewer.Immutable.List<string> | null | undefined;
            subActions?:
                | NutrientViewer.Immutable.List<
                    NutrientViewer.Actions.Action<
                        (ActionProperties),
                        (ActionProperties),
                    >,
                >
                | null;
        }[K],
        next: {
            canonicalFormat: boolean;
            embedForm: boolean;
            excludeFKey: boolean;
            excludeNonUserAnnotations: boolean;
            exportFormat: boolean;
            getMethod: boolean;
            includeAnnotations: boolean;
            includeAppendSaves: boolean;
            includeExclude: boolean;
            includeNoValueFields: boolean;
            submitCoordinated: boolean;
            submitPDF: boolean;
            uri: string;
            xfdf: boolean;
            fields: NutrientViewer.Immutable.List<string> | null | undefined;
            subActions?:
                | NutrientViewer.Immutable.List<
                    NutrientViewer.Actions.Action<
                        (ActionProperties),
                        (ActionProperties),
                    >,
                >
                | null;
        }[K],
        key: K,
    ) => {
        canonicalFormat: boolean;
        embedForm: boolean;
        excludeFKey: boolean;
        excludeNonUserAnnotations: boolean;
        exportFormat: boolean;
        getMethod: boolean;
        includeAnnotations: boolean;
        includeAppendSaves: boolean;
        includeExclude: boolean;
        includeNoValueFields: boolean;
        submitCoordinated: boolean;
        submitPDF: boolean;
        uri: string;
        xfdf: boolean;
        fields: NutrientViewer.Immutable.List<string> | null | undefined;
        subActions?:
            | NutrientViewer.Immutable.List<
                NutrientViewer.Actions.Action<(ActionProperties), (ActionProperties)>,
            >
            | null;
    }[K],
    ...collections: (
        | Partial<
            {
                canonicalFormat: boolean;
                embedForm: boolean;
                excludeFKey: boolean;
                excludeNonUserAnnotations: boolean;
                exportFormat: boolean;
                getMethod: boolean;
                includeAnnotations: boolean;
                includeAppendSaves: boolean;
                includeExclude: boolean;
                includeNoValueFields: boolean;
                submitCoordinated: boolean;
                submitPDF: boolean;
                uri: string;
                xfdf: boolean;
                fields: NutrientViewer.Immutable.List<string>
                | null
                | undefined;
                subActions?:
                    | NutrientViewer.Immutable.List<
                        NutrientViewer.Actions.Action<
                            (ActionProperties),
                            (ActionProperties),
                        >,
                    >
                    | null;
            },
        >
        | Iterable<readonly [string, unknown]>
    )[],
): this
Returns a record with the entries of each collection merged in, calling merger for each key the record already holds to decide the value that is kept.

Keys the record was not defined with are ignored.

Parameters
merger
<K extends string | number | symbol>(
previous: { … }[K],
next: { … }[K],
key: K
) => { … }[K]<K extends string | number | symbol>(
    previous: {
        canonicalFormat: boolean;
        embedForm: boolean;
        excludeFKey: boolean;
        excludeNonUserAnnotations: boolean;
        exportFormat: boolean;
        getMethod: boolean;
        includeAnnotations: boolean;
        includeAppendSaves: boolean;
        includeExclude: boolean;
        includeNoValueFields: boolean;
        submitCoordinated: boolean;
        submitPDF: boolean;
        uri: string;
        xfdf: boolean;
        fields: NutrientViewer.Immutable.List<string> | null | undefined;
        subActions?:
            | NutrientViewer.Immutable.List<
                NutrientViewer.Actions.Action<(ActionProperties), (ActionProperties)>,
            >
            | null;
    }[K],
    next: {
        canonicalFormat: boolean;
        embedForm: boolean;
        excludeFKey: boolean;
        excludeNonUserAnnotations: boolean;
        exportFormat: boolean;
        getMethod: boolean;
        includeAnnotations: boolean;
        includeAppendSaves: boolean;
        includeExclude: boolean;
        includeNoValueFields: boolean;
        submitCoordinated: boolean;
        submitPDF: boolean;
        uri: string;
        xfdf: boolean;
        fields: NutrientViewer.Immutable.List<string> | null | undefined;
        subActions?:
            | NutrientViewer.Immutable.List<
                NutrientViewer.Actions.Action<(ActionProperties), (ActionProperties)>,
            >
            | null;
    }[K],
    key: K,
) => {
    canonicalFormat: boolean;
    embedForm: boolean;
    excludeFKey: boolean;
    excludeNonUserAnnotations: boolean;
    exportFormat: boolean;
    getMethod: boolean;
    includeAnnotations: boolean;
    includeAppendSaves: boolean;
    includeExclude: boolean;
    includeNoValueFields: boolean;
    submitCoordinated: boolean;
    submitPDF: boolean;
    uri: string;
    xfdf: boolean;
    fields: NutrientViewer.Immutable.List<string> | null | undefined;
    subActions?:
        | NutrientViewer.Immutable.List<
            NutrientViewer.Actions.Action<(ActionProperties), (ActionProperties)>,
        >
        | null;
}[K]
Receives the current value, the incoming value and the key.

...collections
(Partial<{ … }> | Iterable<readonly [string, unknown]>)[](
    | Partial<
        {
            canonicalFormat: boolean;
            embedForm: boolean;
            excludeFKey: boolean;
            excludeNonUserAnnotations: boolean;
            exportFormat: boolean;
            getMethod: boolean;
            includeAnnotations: boolean;
            includeAppendSaves: boolean;
            includeExclude: boolean;
            includeNoValueFields: boolean;
            submitCoordinated: boolean;
            submitPDF: boolean;
            uri: string;
            xfdf: boolean;
            fields: NutrientViewer.Immutable.List<string>
            | null
            | undefined;
            subActions?:
                | NutrientViewer.Immutable.List<
                    NutrientViewer.Actions.Action<
                        (ActionProperties),
                        (ActionProperties),
                    >,
                >
                | null;
        },
    >
    | Iterable<readonly [string, unknown]>
)[]
Plain objects or key/value iterables to merge in.

Returns
this
A new record, or this one when no value changed.

Inherited from Action.mergeWith

remove

remove<K extends keyof { … }>(
    key: K & (
        | "uri"
        | "includeExclude"
        | "includeNoValueFields"
        | "exportFormat"
        | "getMethod"
        | "submitCoordinated"
        | "xfdf"
        | "includeAppendSaves"
        | "includeAnnotations"
        | "submitPDF"
        | "canonicalFormat"
        | "excludeNonUserAnnotations"
        | "excludeFKey"
        | "embedForm"
        | "fields"
        | "subActions"
    ),
): thisremove<
    K extends
        keyof {
            canonicalFormat: boolean;
            embedForm: boolean;
            excludeFKey: boolean;
            excludeNonUserAnnotations: boolean;
            exportFormat: boolean;
            getMethod: boolean;
            includeAnnotations: boolean;
            includeAppendSaves: boolean;
            includeExclude: boolean;
            includeNoValueFields: boolean;
            submitCoordinated: boolean;
            submitPDF: boolean;
            uri: string;
            xfdf: boolean;
            fields: NutrientViewer.Immutable.List<string>
            | null
            | undefined;
            subActions?:
                | NutrientViewer.Immutable.List<
                    NutrientViewer.Actions.Action<
                        (ActionProperties),
                        (ActionProperties),
                    >,
                >
                | null;
        },
>(
    key: K & (
        | "uri"
        | "includeExclude"
        | "includeNoValueFields"
        | "exportFormat"
        | "getMethod"
        | "submitCoordinated"
        | "xfdf"
        | "includeAppendSaves"
        | "includeAnnotations"
        | "submitPDF"
        | "canonicalFormat"
        | "excludeNonUserAnnotations"
        | "excludeFKey"
        | "embedForm"
        | "fields"
        | "subActions"
    ),
): this
An alias for delete.

Type Parameters
K
extends keyof { … }extends keyof {
    canonicalFormat: boolean;
    embedForm: boolean;
    excludeFKey: boolean;
    excludeNonUserAnnotations: boolean;
    exportFormat: boolean;
    getMethod: boolean;
    includeAnnotations: boolean;
    includeAppendSaves: boolean;
    includeExclude: boolean;
    includeNoValueFields: boolean;
    submitCoordinated: boolean;
    submitPDF: boolean;
    uri: string;
    xfdf: boolean;
    fields: NutrientViewer.Immutable.List<string> | null | undefined;
    subActions?:
        | NutrientViewer.Immutable.List<
            NutrientViewer.Actions.Action<(ActionProperties), (ActionProperties)>,
        >
        | null;
}
Parameters
keyK & (
| "uri"
| "includeExclude"
| "includeNoValueFields"
| "exportFormat"
| "getMethod"
| "submitCoordinated"
| "xfdf"
| "includeAppendSaves"
| "includeAnnotations"
| "submitPDF"
| "canonicalFormat"
| "excludeNonUserAnnotations"
| "excludeFKey"
| "embedForm"
| "fields"
| "subActions"
)
One of the keys this record was defined with.

Returns
this
A new record, or this one when the value already equals the default.

Inherited from Action.remove

removeIn

removeIn(keyPath: Iterable<unknown>): this
An alias for deleteIn.

Parameters
keyPathIterable<unknown>
The keys to follow, outermost first.

Returns
this
A new record, or this one when nothing was removed.

Inherited from Action.removeIn

set

set<K extends keyof { … }>(
    key: K & (
        | "uri"
        | "includeExclude"
        | "includeNoValueFields"
        | "exportFormat"
        | "getMethod"
        | "submitCoordinated"
        | "xfdf"
        | "includeAppendSaves"
        | "includeAnnotations"
        | "submitPDF"
        | "canonicalFormat"
        | "excludeNonUserAnnotations"
        | "excludeFKey"
        | "embedForm"
        | "fields"
        | "subActions"
    ),
    value: { … }[K],
): thisset<
    K extends
        keyof {
            canonicalFormat: boolean;
            embedForm: boolean;
            excludeFKey: boolean;
            excludeNonUserAnnotations: boolean;
            exportFormat: boolean;
            getMethod: boolean;
            includeAnnotations: boolean;
            includeAppendSaves: boolean;
            includeExclude: boolean;
            includeNoValueFields: boolean;
            submitCoordinated: boolean;
            submitPDF: boolean;
            uri: string;
            xfdf: boolean;
            fields: NutrientViewer.Immutable.List<string>
            | null
            | undefined;
            subActions?:
                | NutrientViewer.Immutable.List<
                    NutrientViewer.Actions.Action<
                        (ActionProperties),
                        (ActionProperties),
                    >,
                >
                | null;
        },
>(
    key: K & (
        | "uri"
        | "includeExclude"
        | "includeNoValueFields"
        | "exportFormat"
        | "getMethod"
        | "submitCoordinated"
        | "xfdf"
        | "includeAppendSaves"
        | "includeAnnotations"
        | "submitPDF"
        | "canonicalFormat"
        | "excludeNonUserAnnotations"
        | "excludeFKey"
        | "embedForm"
        | "fields"
        | "subActions"
    ),
    value: {
        canonicalFormat: boolean;
        embedForm: boolean;
        excludeFKey: boolean;
        excludeNonUserAnnotations: boolean;
        exportFormat: boolean;
        getMethod: boolean;
        includeAnnotations: boolean;
        includeAppendSaves: boolean;
        includeExclude: boolean;
        includeNoValueFields: boolean;
        submitCoordinated: boolean;
        submitPDF: boolean;
        uri: string;
        xfdf: boolean;
        fields: NutrientViewer.Immutable.List<string> | null | undefined;
        subActions?:
            | NutrientViewer.Immutable.List<
                NutrientViewer.Actions.Action<(ActionProperties), (ActionProperties)>,
            >
            | null;
    }[K],
): this
Returns a record with key set to value.

Setting a key to the value it already holds returns the same instance, so a record can be compared by reference to detect a change.

Type Parameters
K
extends keyof { … }extends keyof {
    canonicalFormat: boolean;
    embedForm: boolean;
    excludeFKey: boolean;
    excludeNonUserAnnotations: boolean;
    exportFormat: boolean;
    getMethod: boolean;
    includeAnnotations: boolean;
    includeAppendSaves: boolean;
    includeExclude: boolean;
    includeNoValueFields: boolean;
    submitCoordinated: boolean;
    submitPDF: boolean;
    uri: string;
    xfdf: boolean;
    fields: NutrientViewer.Immutable.List<string> | null | undefined;
    subActions?:
        | NutrientViewer.Immutable.List<
            NutrientViewer.Actions.Action<(ActionProperties), (ActionProperties)>,
        >
        | null;
}
Parameters
keyK & (
| "uri"
| "includeExclude"
| "includeNoValueFields"
| "exportFormat"
| "getMethod"
| "submitCoordinated"
| "xfdf"
| "includeAppendSaves"
| "includeAnnotations"
| "submitPDF"
| "canonicalFormat"
| "excludeNonUserAnnotations"
| "excludeFKey"
| "embedForm"
| "fields"
| "subActions"
)
One of the keys this record was defined with.

value
{ … }[K]{
    canonicalFormat: boolean;
    embedForm: boolean;
    excludeFKey: boolean;
    excludeNonUserAnnotations: boolean;
    exportFormat: boolean;
    getMethod: boolean;
    includeAnnotations: boolean;
    includeAppendSaves: boolean;
    includeExclude: boolean;
    includeNoValueFields: boolean;
    submitCoordinated: boolean;
    submitPDF: boolean;
    uri: string;
    xfdf: boolean;
    fields: NutrientViewer.Immutable.List<string> | null | undefined;
    subActions?:
        | NutrientViewer.Immutable.List<
            NutrientViewer.Actions.Action<(ActionProperties), (ActionProperties)>,
        >
        | null;
}[K]
The value to store.

Returns
this
A new record, or this one when the value is unchanged or the key is not defined.

Inherited from Action.set

setIn

setIn(keyPath: Iterable<unknown>, value: unknown): this
Returns a record with value written at keyPath.

Parameters
keyPathIterable<unknown>
The keys to follow, outermost first.

valueunknown
The value to store.

Returns
this
A new record, or this one when the value is unchanged.

Inherited from Action.setIn

toJS

toJS(): { … }toJS(): {
    uri: string;
    includeExclude: boolean;
    includeNoValueFields: boolean;
    exportFormat: boolean;
    getMethod: boolean;
    submitCoordinated: boolean;
    xfdf: boolean;
    includeAppendSaves: boolean;
    includeAnnotations: boolean;
    submitPDF: boolean;
    canonicalFormat: boolean;
    excludeNonUserAnnotations: boolean;
    excludeFKey: boolean;
    embedForm: boolean;
    fields: string[]
    | null
    | undefined;
    subActions?:
        | (
            (ActionProperties) & {
                subActions?: Action<(ActionProperties), (ActionProperties)>[] | null;
            }
        )[]
        | null;
}
Converts this record and everything nested inside it to plain JavaScript values.
Returns
{ … }{
    uri: string;
    includeExclude: boolean;
    includeNoValueFields: boolean;
    exportFormat: boolean;
    getMethod: boolean;
    submitCoordinated: boolean;
    xfdf: boolean;
    includeAppendSaves: boolean;
    includeAnnotations: boolean;
    submitPDF: boolean;
    canonicalFormat: boolean;
    excludeNonUserAnnotations: boolean;
    excludeFKey: boolean;
    embedForm: boolean;
    fields: string[] | null | undefined;
    subActions?:
        | (
            (ActionProperties) & {
                subActions?: Action<(ActionProperties), (ActionProperties)>[] | null;
            }
        )[]
        | null;
}
A plain object holding this record's values, converted all the way down.

uri: string
The uniform resource identifier (web link) defining where the form should be submitted to, when this action got triggered.

includeExclude: boolean
If false, the fields list specifies which fields to submit. If true, the fields list indicates which fields to exclude from submitting. That is, all fields in the document’s interactive form shall be submitted except those listed in the fields list.

Default Value
false
includeNoValueFields: boolean
This option is not supported yet. If true, all fields designated by the Fields array and the IncludeExclude flag shall be submitted, regardless of whether they have a value. For fields without a value, only the field name shall be transmitted. If false, fields without a value shall not be submitted.

Default Value
true
exportFormat: boolean
Meaningful only if the submitPDF and xfdf flags are false. If set, field names and values shall be submitted in HTML Form format. If false, they shall be submitted in Forms Data Format (FDF)

Default Value
true
getMethod: boolean
If true, field names and values shall be submitted using an HTTP GET request. If false, they shall be submitted using a POST request. This flag is meaningful only when the exportFormat flag is set. If exportFormat is false, this flag shall also be false.

Default Value
false
submitCoordinated: boolean
This option is not supported yet. If true, the coordinates of the mouse click that caused the submit-form action shall be transmitted as part of the form data. The coordinate values are relative to the upper-left corner of the field’s widget annotation rectangle. They shall be represented in the data in the format name.x=xval&name.y=yval where name is the field’s name.

Default Value
false
xfdf: boolean
This option is not supported yet. Shall be used only if the SubmitPDF flags are false. If true, field names and values shall be submitted as XFDF.

Default Value
false
includeAppendSaves: boolean
This option is not supported yet. Shall be used only when the form is being submitted in Forms Data Format (that is, when both the XFDF and ExportFormat flags are false). If true, the submitted FDF file shall include the contents of all incremental updates to the underlying PDF document, as contained in the Differences entry in the FDF dictionary. If false, the incremental updates shall not be included.

Default Value
false
includeAnnotations: boolean
This option is not supported yet. shall be used only when the form is being submitted in Forms Data Format (that is, when both the XFDF and ExportFormat flags are false). If set, the submitted FDF file shall include all markup annotations in the underlying PDF document. If false, markup annotations shall not be included.

Default Value
false
submitPDF: boolean
If true, the document shall be submitted as PDF, using the MIME content type application/pdf.

Default Value
false
canonicalFormat: boolean
This option is not supported yet. If true, any submitted field values representing dates shall be converted to the standard format.

Default Value
false
excludeNonUserAnnotations: boolean
This option is not supported yet. shall be used only when the form is being submitted in Forms Data Format (that is, when both the XFDF and ExportFormat flags are false) and the IncludeAnnotations flag is true. If true, it shall include only those markup annotations those T entry matches the name of the current user, as determined by the remote server to which the form is being submitted.

Default Value
false
excludeFKey: boolean
This option is not supported yet. Shall be used only when the form is being submitted in Forms Data Format (that is, when both the XFDF and ExportFormat flags are false). If true, the submitted FDF shall exclude the F entry.

Default Value
false
embedForm: boolean
This option is not supported yet. shall be used only when the form is being submitted in Forms Data Format (that is, when both the XFDF and ExportFormat flags are false). If true, the F entry of the submitted FDF shall be a file specification containing an embedded file stream representing the PDF file from which the FDF is being submitted.

Default Value
false
fields: string[] | null | undefined
A List identifying which fields to submit or which to exclude from submitting, depending on the setting of the includeExclude flag. Each element of the array shall be a text string representing the fully qualified name of a field. If this entry is omitted, the includeExclude flag shall be ignored; all fields in the document’s interactive form are submitted.

Default Value
null
Optional
subActions?:
    | (
        (ActionProperties) & {
            subActions?: Action<(ActionProperties), (ActionProperties)>[] | null;
        }
    )[]
    | null
Actions can be chained by adding them to this immutable List.
Inherited from Action.toJS

toJSON

toJSON(): { … }toJSON(): {
    canonicalFormat: boolean;
    embedForm: boolean;
    excludeFKey: boolean;
    excludeNonUserAnnotations: boolean;
    exportFormat: boolean;
    getMethod: boolean;
    includeAnnotations: boolean;
    includeAppendSaves: boolean;
    includeExclude: boolean;
    includeNoValueFields: boolean;
    submitCoordinated: boolean;
    submitPDF: boolean;
    uri: string;
    xfdf: boolean;
    fields: NutrientViewer.Immutable.List<string>
    | null
    | undefined;
    subActions?:
        | NutrientViewer.Immutable.List<
            NutrientViewer.Actions.Action<(ActionProperties), (ActionProperties)>,
        >
        | null;
}
An alias for toObject, called by JSON.stringify.
Returns
{ … }{
    canonicalFormat: boolean;
    embedForm: boolean;
    excludeFKey: boolean;
    excludeNonUserAnnotations: boolean;
    exportFormat: boolean;
    getMethod: boolean;
    includeAnnotations: boolean;
    includeAppendSaves: boolean;
    includeExclude: boolean;
    includeNoValueFields: boolean;
    submitCoordinated: boolean;
    submitPDF: boolean;
    uri: string;
    xfdf: boolean;
    fields: NutrientViewer.Immutable.List<string> | null | undefined;
    subActions?:
        | NutrientViewer.Immutable.List<
            NutrientViewer.Actions.Action<(ActionProperties), (ActionProperties)>,
        >
        | null;
}
A plain object holding this record's values.

canonicalFormat: boolean
This option is not supported yet. If true, any submitted field values representing dates shall be converted to the standard format.

Default Value
false
embedForm: boolean
This option is not supported yet. shall be used only when the form is being submitted in Forms Data Format (that is, when both the XFDF and ExportFormat flags are false). If true, the F entry of the submitted FDF shall be a file specification containing an embedded file stream representing the PDF file from which the FDF is being submitted.

Default Value
false
excludeFKey: boolean
This option is not supported yet. Shall be used only when the form is being submitted in Forms Data Format (that is, when both the XFDF and ExportFormat flags are false). If true, the submitted FDF shall exclude the F entry.

Default Value
false
excludeNonUserAnnotations: boolean
This option is not supported yet. shall be used only when the form is being submitted in Forms Data Format (that is, when both the XFDF and ExportFormat flags are false) and the IncludeAnnotations flag is true. If true, it shall include only those markup annotations those T entry matches the name of the current user, as determined by the remote server to which the form is being submitted.

Default Value
false
exportFormat: boolean
Meaningful only if the submitPDF and xfdf flags are false. If set, field names and values shall be submitted in HTML Form format. If false, they shall be submitted in Forms Data Format (FDF)

Default Value
true
getMethod: boolean
If true, field names and values shall be submitted using an HTTP GET request. If false, they shall be submitted using a POST request. This flag is meaningful only when the exportFormat flag is set. If exportFormat is false, this flag shall also be false.

Default Value
false
includeAnnotations: boolean
This option is not supported yet. shall be used only when the form is being submitted in Forms Data Format (that is, when both the XFDF and ExportFormat flags are false). If set, the submitted FDF file shall include all markup annotations in the underlying PDF document. If false, markup annotations shall not be included.

Default Value
false
includeAppendSaves: boolean
This option is not supported yet. Shall be used only when the form is being submitted in Forms Data Format (that is, when both the XFDF and ExportFormat flags are false). If true, the submitted FDF file shall include the contents of all incremental updates to the underlying PDF document, as contained in the Differences entry in the FDF dictionary. If false, the incremental updates shall not be included.

Default Value
false
includeExclude: boolean
If false, the fields list specifies which fields to submit. If true, the fields list indicates which fields to exclude from submitting. That is, all fields in the document’s interactive form shall be submitted except those listed in the fields list.

Default Value
false
includeNoValueFields: boolean
This option is not supported yet. If true, all fields designated by the Fields array and the IncludeExclude flag shall be submitted, regardless of whether they have a value. For fields without a value, only the field name shall be transmitted. If false, fields without a value shall not be submitted.

Default Value
true
submitCoordinated: boolean
This option is not supported yet. If true, the coordinates of the mouse click that caused the submit-form action shall be transmitted as part of the form data. The coordinate values are relative to the upper-left corner of the field’s widget annotation rectangle. They shall be represented in the data in the format name.x=xval&name.y=yval where name is the field’s name.

Default Value
false
submitPDF: boolean
If true, the document shall be submitted as PDF, using the MIME content type application/pdf.

Default Value
false
uri: string
The uniform resource identifier (web link) defining where the form should be submitted to, when this action got triggered.

xfdf: boolean
This option is not supported yet. Shall be used only if the SubmitPDF flags are false. If true, field names and values shall be submitted as XFDF.

Default Value
false
fields: NutrientViewer.Immutable.List<string> | null | undefined
A List identifying which fields to submit or which to exclude from submitting, depending on the setting of the includeExclude flag. Each element of the array shall be a text string representing the fully qualified name of a field. If this entry is omitted, the includeExclude flag shall be ignored; all fields in the document’s interactive form are submitted.

Default Value
null
Optional
subActions?:
    | NutrientViewer.Immutable.List<
        NutrientViewer.Actions.Action<(ActionProperties), (ActionProperties)>,
    >
    | null
Actions can be chained by adding them to this immutable List.
Inherited from Action.toJSON

toObject

toObject(): { … }toObject(): {
    canonicalFormat: boolean;
    embedForm: boolean;
    excludeFKey: boolean;
    excludeNonUserAnnotations: boolean;
    exportFormat: boolean;
    getMethod: boolean;
    includeAnnotations: boolean;
    includeAppendSaves: boolean;
    includeExclude: boolean;
    includeNoValueFields: boolean;
    submitCoordinated: boolean;
    submitPDF: boolean;
    uri: string;
    xfdf: boolean;
    fields: NutrientViewer.Immutable.List<string>
    | null
    | undefined;
    subActions?:
        | NutrientViewer.Immutable.List<
            NutrientViewer.Actions.Action<(ActionProperties), (ActionProperties)>,
        >
        | null;
}
Converts this record to a plain object, one level deep. Nested records are left as they are.
Returns
{ … }{
    canonicalFormat: boolean;
    embedForm: boolean;
    excludeFKey: boolean;
    excludeNonUserAnnotations: boolean;
    exportFormat: boolean;
    getMethod: boolean;
    includeAnnotations: boolean;
    includeAppendSaves: boolean;
    includeExclude: boolean;
    includeNoValueFields: boolean;
    submitCoordinated: boolean;
    submitPDF: boolean;
    uri: string;
    xfdf: boolean;
    fields: NutrientViewer.Immutable.List<string> | null | undefined;
    subActions?:
        | NutrientViewer.Immutable.List<
            NutrientViewer.Actions.Action<(ActionProperties), (ActionProperties)>,
        >
        | null;
}
A plain object holding this record's values.

canonicalFormat: boolean
This option is not supported yet. If true, any submitted field values representing dates shall be converted to the standard format.

Default Value
false
embedForm: boolean
This option is not supported yet. shall be used only when the form is being submitted in Forms Data Format (that is, when both the XFDF and ExportFormat flags are false). If true, the F entry of the submitted FDF shall be a file specification containing an embedded file stream representing the PDF file from which the FDF is being submitted.

Default Value
false
excludeFKey: boolean
This option is not supported yet. Shall be used only when the form is being submitted in Forms Data Format (that is, when both the XFDF and ExportFormat flags are false). If true, the submitted FDF shall exclude the F entry.

Default Value
false
excludeNonUserAnnotations: boolean
This option is not supported yet. shall be used only when the form is being submitted in Forms Data Format (that is, when both the XFDF and ExportFormat flags are false) and the IncludeAnnotations flag is true. If true, it shall include only those markup annotations those T entry matches the name of the current user, as determined by the remote server to which the form is being submitted.

Default Value
false
exportFormat: boolean
Meaningful only if the submitPDF and xfdf flags are false. If set, field names and values shall be submitted in HTML Form format. If false, they shall be submitted in Forms Data Format (FDF)

Default Value
true
getMethod: boolean
If true, field names and values shall be submitted using an HTTP GET request. If false, they shall be submitted using a POST request. This flag is meaningful only when the exportFormat flag is set. If exportFormat is false, this flag shall also be false.

Default Value
false
includeAnnotations: boolean
This option is not supported yet. shall be used only when the form is being submitted in Forms Data Format (that is, when both the XFDF and ExportFormat flags are false). If set, the submitted FDF file shall include all markup annotations in the underlying PDF document. If false, markup annotations shall not be included.

Default Value
false
includeAppendSaves: boolean
This option is not supported yet. Shall be used only when the form is being submitted in Forms Data Format (that is, when both the XFDF and ExportFormat flags are false). If true, the submitted FDF file shall include the contents of all incremental updates to the underlying PDF document, as contained in the Differences entry in the FDF dictionary. If false, the incremental updates shall not be included.

Default Value
false
includeExclude: boolean
If false, the fields list specifies which fields to submit. If true, the fields list indicates which fields to exclude from submitting. That is, all fields in the document’s interactive form shall be submitted except those listed in the fields list.

Default Value
false
includeNoValueFields: boolean
This option is not supported yet. If true, all fields designated by the Fields array and the IncludeExclude flag shall be submitted, regardless of whether they have a value. For fields without a value, only the field name shall be transmitted. If false, fields without a value shall not be submitted.

Default Value
true
submitCoordinated: boolean
This option is not supported yet. If true, the coordinates of the mouse click that caused the submit-form action shall be transmitted as part of the form data. The coordinate values are relative to the upper-left corner of the field’s widget annotation rectangle. They shall be represented in the data in the format name.x=xval&name.y=yval where name is the field’s name.

Default Value
false
submitPDF: boolean
If true, the document shall be submitted as PDF, using the MIME content type application/pdf.

Default Value
false
uri: string
The uniform resource identifier (web link) defining where the form should be submitted to, when this action got triggered.

xfdf: boolean
This option is not supported yet. Shall be used only if the SubmitPDF flags are false. If true, field names and values shall be submitted as XFDF.

Default Value
false
fields: NutrientViewer.Immutable.List<string> | null | undefined
A List identifying which fields to submit or which to exclude from submitting, depending on the setting of the includeExclude flag. Each element of the array shall be a text string representing the fully qualified name of a field. If this entry is omitted, the includeExclude flag shall be ignored; all fields in the document’s interactive form are submitted.

Default Value
null
Optional
subActions?:
    | NutrientViewer.Immutable.List<
        NutrientViewer.Actions.Action<(ActionProperties), (ActionProperties)>,
    >
    | null
Actions can be chained by adding them to this immutable List.
Inherited from Action.toObject

update

update<K extends keyof { … }>(
    key: K & (
        | "uri"
        | "includeExclude"
        | "includeNoValueFields"
        | "exportFormat"
        | "getMethod"
        | "submitCoordinated"
        | "xfdf"
        | "includeAppendSaves"
        | "includeAnnotations"
        | "submitPDF"
        | "canonicalFormat"
        | "excludeNonUserAnnotations"
        | "excludeFKey"
        | "embedForm"
        | "fields"
        | "subActions"
    ),
    updater: (value: { … }[K]) => { … }[K],
): thisupdate<
    K extends
        keyof {
            canonicalFormat: boolean;
            embedForm: boolean;
            excludeFKey: boolean;
            excludeNonUserAnnotations: boolean;
            exportFormat: boolean;
            getMethod: boolean;
            includeAnnotations: boolean;
            includeAppendSaves: boolean;
            includeExclude: boolean;
            includeNoValueFields: boolean;
            submitCoordinated: boolean;
            submitPDF: boolean;
            uri: string;
            xfdf: boolean;
            fields: NutrientViewer.Immutable.List<string>
            | null
            | undefined;
            subActions?:
                | NutrientViewer.Immutable.List<
                    NutrientViewer.Actions.Action<
                        (ActionProperties),
                        (ActionProperties),
                    >,
                >
                | null;
        },
>(
    key: K & (
        | "uri"
        | "includeExclude"
        | "includeNoValueFields"
        | "exportFormat"
        | "getMethod"
        | "submitCoordinated"
        | "xfdf"
        | "includeAppendSaves"
        | "includeAnnotations"
        | "submitPDF"
        | "canonicalFormat"
        | "excludeNonUserAnnotations"
        | "excludeFKey"
        | "embedForm"
        | "fields"
        | "subActions"
    ),
    updater: (
        value: {
            canonicalFormat: boolean;
            embedForm: boolean;
            excludeFKey: boolean;
            excludeNonUserAnnotations: boolean;
            exportFormat: boolean;
            getMethod: boolean;
            includeAnnotations: boolean;
            includeAppendSaves: boolean;
            includeExclude: boolean;
            includeNoValueFields: boolean;
            submitCoordinated: boolean;
            submitPDF: boolean;
            uri: string;
            xfdf: boolean;
            fields: NutrientViewer.Immutable.List<string> | null | undefined;
            subActions?:
                | NutrientViewer.Immutable.List<
                    NutrientViewer.Actions.Action<
                        (ActionProperties),
                        (ActionProperties),
                    >,
                >
                | null;
        }[K],
    ) => {
        canonicalFormat: boolean;
        embedForm: boolean;
        excludeFKey: boolean;
        excludeNonUserAnnotations: boolean;
        exportFormat: boolean;
        getMethod: boolean;
        includeAnnotations: boolean;
        includeAppendSaves: boolean;
        includeExclude: boolean;
        includeNoValueFields: boolean;
        submitCoordinated: boolean;
        submitPDF: boolean;
        uri: string;
        xfdf: boolean;
        fields: NutrientViewer.Immutable.List<string>
        | null
        | undefined;
        subActions?:
            | NutrientViewer.Immutable.List<
                NutrientViewer.Actions.Action<(ActionProperties), (ActionProperties)>,
            >
            | null;
    }[K],
): this
Returns a record with key replaced by the result of applying updater to its current value.

Type Parameters
K
extends keyof { … }extends keyof {
    canonicalFormat: boolean;
    embedForm: boolean;
    excludeFKey: boolean;
    excludeNonUserAnnotations: boolean;
    exportFormat: boolean;
    getMethod: boolean;
    includeAnnotations: boolean;
    includeAppendSaves: boolean;
    includeExclude: boolean;
    includeNoValueFields: boolean;
    submitCoordinated: boolean;
    submitPDF: boolean;
    uri: string;
    xfdf: boolean;
    fields: NutrientViewer.Immutable.List<string> | null | undefined;
    subActions?:
        | NutrientViewer.Immutable.List<
            NutrientViewer.Actions.Action<(ActionProperties), (ActionProperties)>,
        >
        | null;
}
Parameters
keyK & (
| "uri"
| "includeExclude"
| "includeNoValueFields"
| "exportFormat"
| "getMethod"
| "submitCoordinated"
| "xfdf"
| "includeAppendSaves"
| "includeAnnotations"
| "submitPDF"
| "canonicalFormat"
| "excludeNonUserAnnotations"
| "excludeFKey"
| "embedForm"
| "fields"
| "subActions"
)
One of the keys this record was defined with.

updater
(value: { … }[K]) => { … }[K](
    value: {
        canonicalFormat: boolean;
        embedForm: boolean;
        excludeFKey: boolean;
        excludeNonUserAnnotations: boolean;
        exportFormat: boolean;
        getMethod: boolean;
        includeAnnotations: boolean;
        includeAppendSaves: boolean;
        includeExclude: boolean;
        includeNoValueFields: boolean;
        submitCoordinated: boolean;
        submitPDF: boolean;
        uri: string;
        xfdf: boolean;
        fields: NutrientViewer.Immutable.List<string> | null | undefined;
        subActions?:
            | NutrientViewer.Immutable.List<
                NutrientViewer.Actions.Action<(ActionProperties), (ActionProperties)>,
            >
            | null;
    }[K],
) => {
    canonicalFormat: boolean;
    embedForm: boolean;
    excludeFKey: boolean;
    excludeNonUserAnnotations: boolean;
    exportFormat: boolean;
    getMethod: boolean;
    includeAnnotations: boolean;
    includeAppendSaves: boolean;
    includeExclude: boolean;
    includeNoValueFields: boolean;
    submitCoordinated: boolean;
    submitPDF: boolean;
    uri: string;
    xfdf: boolean;
    fields: NutrientViewer.Immutable.List<string>
    | null
    | undefined;
    subActions?:
        | NutrientViewer.Immutable.List<
            NutrientViewer.Actions.Action<(ActionProperties), (ActionProperties)>,
        >
        | null;
}[K]
Receives the current value and returns the new one.

Returns
this
A new record, or this one when the value is unchanged.

Inherited from Action.update

updateIn

updateIn<N>(
    keyPath: Iterable<unknown>,
    notSetValue: N,
    updater: (value: unknown) => unknown,
): this
Returns a record with the value at keyPath replaced by the result of updater.

Type Parameters
N
Parameters
keyPathIterable<unknown>
The keys to follow, outermost first.

notSetValueN
updater(value: unknown) => unknown
Receives the current value and returns the new one.

Returns
this
A new record, or this one when the value is unchanged.

Inherited from Action.updateIn
updateIn(keyPath: Iterable<unknown>, updater: (value: unknown) => unknown): this
Returns a record with the value at keyPath replaced by the result of updater.

Parameters
keyPathIterable<unknown>
The keys to follow, outermost first.

updater(value: unknown) => unknown
Receives the current value and returns the new one.

Returns
this
A new record, or this one when the value is unchanged.

Inherited from Action.updateIn

withMutations

withMutations(mutator: (mutable: this) => unknown): this
Applies several changes as one, so only a single new record is allocated.

The record handed to mutator may be written to with set; it is frozen again once mutator returns.

Parameters
mutator(mutable: this) => unknown
Receives a temporarily writable copy of this record.

Returns
this
A new record holding the applied changes, or this one when nothing changed.

Inherited from Action.withMutations

Class SubmitFormAction

Example

Hierarchy

Constructors

Parameters

Properties

Default Value

Default Value

Default Value

Default Value

Default Value

Default Value

Default Value

Default Value

Default Value

Default Value

Default Value

Default Value

Default Value

Default Value

Methods

Returns

Immutable Record API

Returns

Returns

Type Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Deprecated

Type Parameters

Parameters

Returns

Parameters

Returns

Type Parameters

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Type Parameters

Parameters

Returns

Parameters

Returns

Type Parameters

Parameters

Returns

Parameters

Returns

Returns

uri: string

includeExclude: boolean

Default Value

includeNoValueFields: boolean

Default Value

exportFormat: boolean

Default Value

getMethod: boolean

Default Value

Optional
subActions?:
| (
(ActionProperties) & {
subActions?: Action<(ActionProperties), (ActionProperties)>[] | null;
}
)[]
| null