Reference NutrientViewer ActionsResetFormAction

Class ResetFormAction

PDF action to reset form fields in the current document.

It is an Immutable.Record and thus can be updated using set(key, value), for example: action.set("includeExclude", false);.

A ResetFormAction defines which form fields should be reset, when clicked on it. By default all form fields will be reset to their default value. The includeExclude field defines if the fields specified by fields, which are a NutrientViewer.Immutable.List of form field names, should reset 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 reset. If includeExclude is set to false, which is the default value for this field, only the form fields defined in fields will be reset.

Class

Example

Create a new ResetFormAction

const action = new NutrientViewer.Actions.ResetFormAction({
  fields: List(["exampleField"])
});

Hierarchy

ResetFormActionDataActionResetFormAction

Constructors

new ResetFormAction(args)

Parameters
args
{ … }{
    includeExclude?: boolean;
    fields?: NutrientViewer.Immutable.List<string> | null;
    subActions?:
        | NutrientViewer.Immutable.List<NutrientViewer.Actions.Action>
        | null;
}
Optional
Inherited from ResetFormActionData.constructor

Properties

fields

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

A List identifying which fields to reset or which to exclude from resetting, 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 reset.

Default Value

null

includeExclude

boolean

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

Default Value

false

subActions

Optional

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

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

Immutable Record API

asImmutable

Deprecated

asImmutable(): this
Deprecated
Returns
this
Deprecated
Not part of the collection API the Nutrient Web SDK supports. Build the value once, or use withMutations().
See Also
Map#asImmutable
Inherited from Action.asImmutable

asMutable

Deprecated

asMutable(): this
Deprecated
Returns
this
Deprecated
Not part of the collection API the Nutrient Web SDK supports. Use withMutations().
See Also
Map#asMutable
Inherited from Action.asMutable

clear

clear(): this
Returns a new instance of this Record type with all values set to their default values.

Returns
this
Inherited from Action.clear

delete

delete<K extends "subActions">(key: K): this
Returns a new instance of this Record type with the value for the specific key set to its default value.

Type Parameters
Kextends "subActions"
Parameters
keyK
Returns
this
Inherited from Action.delete

deleteIn

deleteIn(keyPath: Iterable<unknown>): this
Returns a new instance of this Record type with the value at the given key path removed.

Also available as removeIn.

Parameters
keyPathIterable<unknown>
Returns
this
Inherited from Action.deleteIn

equals

equals(other: unknown): boolean
Parameters
otherunknown
Returns
boolean
Inherited from Action.equals

get

get<K extends "subActions">(key: K): { … }[K]get<K extends "subActions">(
    key: K,
): {
    subActions?:
        | NutrientViewer.Immutable.List<NutrientViewer.Actions.Action>
        | null;
}[K]
Returns the value associated with the provided key, which may be the default value defined when creating the Record factory function.

If the requested key is not defined by this Record type, then notSetValue will be returned if provided. Note that this scenario would produce an error when using Flow or TypeScript.

Type Parameters
Kextends "subActions"
Parameters
keyK
Returns
{ … }[K]{
    subActions?:
        | NutrientViewer.Immutable.List<NutrientViewer.Actions.Action>
        | null;
}[K]
Inherited from Action.get

getIn

getIn(keyPath: Iterable<unknown>, notSetValue?: unknown): unknown
Parameters
keyPathIterable<unknown>
notSetValueunknown
Optional
Returns
unknown
Inherited from Action.getIn

has

has(key: unknown): boolean
Parameters
keyunknown
Returns
boolean
Inherited from Action.has

merge

merge(...collections: Partial<{ … }>[]): thismerge(
    ...collections: Partial<
        {
            subActions?: | NutrientViewer.Immutable.List<
                NutrientViewer.Actions.Action,
            >
            | null;
        },
    >[],
): this
Parameters
...collections
Partial<{ … }>[]Partial<
    {
        subActions?: | NutrientViewer.Immutable.List<
            NutrientViewer.Actions.Action,
        >
        | null;
    },
>[]
Returns
this
Inherited from Action.merge

mergeDeep

mergeDeep(
    ...collections: (Iterable<[string, unknown], any, any> | Partial<{ … }>)[],
): thismergeDeep(
    ...collections: (
        | Iterable<[string, unknown], any, any>
        | Partial<
            {
                subActions?: | NutrientViewer.Immutable.List<
                    NutrientViewer.Actions.Action,
                >
                | null;
            },
        >
    )[],
): this
Parameters
...collections
(Iterable<[string, unknown], any, any> | Partial<{ … }>)[](
    | Iterable<[string, unknown], any, any>
    | Partial<
        {
            subActions?: | NutrientViewer.Immutable.List<
                NutrientViewer.Actions.Action,
            >
            | null;
        },
    >
)[]
Returns
this
Inherited from Action.mergeDeep

mergeDeepIn

mergeDeepIn(
    keyPath: Iterable<unknown>,
    ...collections: (Iterable<[string, unknown], any, any> | Partial<{ … }>)[],
): thismergeDeepIn(
    keyPath: Iterable<unknown>,
    ...collections: (
        | Iterable<[string, unknown], any, any>
        | Partial<
            {
                subActions?: | NutrientViewer.Immutable.List<
                    NutrientViewer.Actions.Action,
                >
                | null;
            },
        >
    )[],
): this
Parameters
keyPathIterable<unknown>
...collections
(Iterable<[string, unknown], any, any> | Partial<{ … }>)[](
    | Iterable<[string, unknown], any, any>
    | Partial<
        {
            subActions?: | NutrientViewer.Immutable.List<
                NutrientViewer.Actions.Action,
            >
            | null;
        },
    >
)[]
Returns
this
Inherited from Action.mergeDeepIn

mergeDeepWith

mergeDeepWith(
    merger: (previous?: unknown, next?: unknown, key?: string) => unknown,
    ...collections: (Iterable<[string, unknown], any, any> | Partial<{ … }>)[],
): thismergeDeepWith(
    merger: (previous?: unknown, next?: unknown, key?: string) => unknown,
    ...collections: (
        | Iterable<[string, unknown], any, any>
        | Partial<
            {
                subActions?: | NutrientViewer.Immutable.List<
                    NutrientViewer.Actions.Action,
                >
                | null;
            },
        >
    )[],
): this
Parameters
merger(previous?: unknown, next?: unknown, key?: string) => unknown
...collections
(Iterable<[string, unknown], any, any> | Partial<{ … }>)[](
    | Iterable<[string, unknown], any, any>
    | Partial<
        {
            subActions?: | NutrientViewer.Immutable.List<
                NutrientViewer.Actions.Action,
            >
            | null;
        },
    >
)[]
Returns
this
Inherited from Action.mergeDeepWith

mergeIn

Deprecated

mergeIn(
    keyPath: Iterable<unknown>,
    ...collections: (Iterable<[string, unknown], any, any> | Partial<{ … }>)[],
): thismergeIn(
    keyPath: Iterable<unknown>,
    ...collections: (
        | Iterable<[string, unknown], any, any>
        | Partial<
            {
                subActions?: | NutrientViewer.Immutable.List<
                    NutrientViewer.Actions.Action,
                >
                | null;
            },
        >
    )[],
): this
Deprecated
Parameters
keyPathIterable<unknown>
...collections
(Iterable<[string, unknown], any, any> | Partial<{ … }>)[](
    | Iterable<[string, unknown], any, any>
    | Partial<
        {
            subActions?: | NutrientViewer.Immutable.List<
                NutrientViewer.Actions.Action,
            >
            | null;
        },
    >
)[]
Returns
this
Deprecated
Not part of the collection API the Nutrient Web SDK supports. Use update() followed by merge().

Inherited from Action.mergeIn

mergeWith

mergeWith(
    merger: (previous?: unknown, next?: unknown, key?: string) => unknown,
    ...collections: (Iterable<[string, unknown], any, any> | Partial<{ … }>)[],
): thismergeWith(
    merger: (previous?: unknown, next?: unknown, key?: string) => unknown,
    ...collections: (
        | Iterable<[string, unknown], any, any>
        | Partial<
            {
                subActions?: | NutrientViewer.Immutable.List<
                    NutrientViewer.Actions.Action,
                >
                | null;
            },
        >
    )[],
): this
Parameters
merger(previous?: unknown, next?: unknown, key?: string) => unknown
...collections
(Iterable<[string, unknown], any, any> | Partial<{ … }>)[](
    | Iterable<[string, unknown], any, any>
    | Partial<
        {
            subActions?: | NutrientViewer.Immutable.List<
                NutrientViewer.Actions.Action,
            >
            | null;
        },
    >
)[]
Returns
this
Inherited from Action.mergeWith

removeIn

Deprecated

removeIn(keyPath: Iterable<unknown>): this
Deprecated
Parameters
keyPathIterable<unknown>
Returns
this
Deprecated
Not part of the collection API the Nutrient Web SDK supports. Use deleteIn(), or update() followed by delete().

Inherited from Action.removeIn

set

set<K extends "subActions">(key: K, value: { … }[K]): thisset<K extends "subActions">(
    key: K,
    value: {
        subActions?:
            | NutrientViewer.Immutable.List<NutrientViewer.Actions.Action>
            | null;
    }[K],
): this
Type Parameters
Kextends "subActions"
Parameters
keyK
value
{ … }[K]{
    subActions?:
        | NutrientViewer.Immutable.List<NutrientViewer.Actions.Action>
        | null;
}[K]
Returns
this
Inherited from Action.set

setIn

setIn(keyPath: Iterable<unknown>, value: unknown): this
Parameters
keyPathIterable<unknown>
valueunknown
Returns
this
Inherited from Action.setIn

toJS

toJS(): { … }toJS(): {
    subActions?: | NutrientViewer.Immutable.List<
        NutrientViewer.Actions.Action,
    >
    | null;
}
Deeply converts this Record to equivalent native JavaScript Object.

Note: This method may not be overridden. Objects with custom serialization to plain JS may override toJSON() instead.

Returns
{ … }{
    subActions?:
        | NutrientViewer.Immutable.List<NutrientViewer.Actions.Action>
        | null;
}
Inherited from Action.toJS

toJSON

toJSON(): { … }toJSON(): {
    subActions?: | NutrientViewer.Immutable.List<
        NutrientViewer.Actions.Action,
    >
    | null;
}
Shallowly converts this Record to equivalent native JavaScript Object.

Returns
{ … }{
    subActions?:
        | NutrientViewer.Immutable.List<NutrientViewer.Actions.Action>
        | null;
}
Inherited from Action.toJSON

toSeq

Deprecated

toSeq(): Keyed<string, unknown>
Deprecated
Returns
Keyed<string, unknown>
Deprecated
Not part of the collection API the Nutrient Web SDK supports. Use entries().

Inherited from Action.toSeq

update

update<K extends "subActions">(
    key: K,
    updater: (value: { … }[K]) => { … }[K],
): thisupdate<K extends "subActions">(
    key: K,
    updater: (
        value: {
            subActions?:
                | NutrientViewer.Immutable.List<NutrientViewer.Actions.Action>
                | null;
        }[K],
    ) => {
        subActions?: | NutrientViewer.Immutable.List<
            NutrientViewer.Actions.Action,
        >
        | null;
    }[K],
): this
Type Parameters
Kextends "subActions"
Parameters
keyK
updater
(value: { … }[K]) => { … }[K](
    value: {
        subActions?:
            | NutrientViewer.Immutable.List<NutrientViewer.Actions.Action>
            | null;
    }[K],
) => {
    subActions?: | NutrientViewer.Immutable.List<
        NutrientViewer.Actions.Action,
    >
    | null;
}[K]
Returns
this
Inherited from Action.update

updateIn

updateIn(
    keyPath: Iterable<unknown>,
    notSetValue: unknown,
    updater: (value: unknown) => unknown,
): this
Parameters
keyPathIterable<unknown>
notSetValueunknown
updater(value: unknown) => unknown
Returns
this
Inherited from Action.updateIn
updateIn(keyPath: Iterable<unknown>, updater: (value: unknown) => unknown): this
Parameters
keyPathIterable<unknown>
updater(value: unknown) => unknown
Returns
this
Inherited from Action.updateIn

withMutations

withMutations(mutator: (mutable: this) => unknown): this
Note: Not all methods can be used on a mutable collection or within withMutations! Only set may be used mutatively.
Parameters
mutator(mutable: this) => unknown
Returns
this
See Also
Map#withMutations
Inherited from Action.withMutations

Class ResetFormAction

Example

Hierarchy

Constructors

Parameters

Properties

Default Value

Default Value

Immutable Record API

Returns

Deprecated

See Also

Returns

Deprecated

See Also

Returns

Type Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Type Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Deprecated

Parameters

Returns

Parameters

Returns

Deprecated

Type Parameters

Parameters

Returns

Parameters

Returns

Returns

Returns

Returns

Deprecated

Type Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

See Also