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.

Example

Create a new ResetFormAction

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

Hierarchy

NutrientViewer.Actions.Action
- ResetFormAction

Index

Constructors

constructor

new ResetFormAction(
    args?: {
        fields?: null | NutrientViewer.Immutable.List<string>;
        includeExclude?: boolean;
        subActions?:
            | null
            | NutrientViewer.Immutable.List<NutrientViewer.Actions.Action>;
    },
): NutrientViewer.Actions.ResetFormAction
Parameters
- Optionalargs: {
      fields?: null | NutrientViewer.Immutable.List<string>;
      includeExclude?: boolean;
      subActions?:
          | null
          | NutrientViewer.Immutable.List<NutrientViewer.Actions.Action>;
  }
Returns NutrientViewer.Actions.ResetFormAction
Overrides Action.constructor

Properties

fields

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

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

null

includeExclude

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

false

`Optional`subActions

subActions?: null | NutrientViewer.Immutable.List<NutrientViewer.Actions.Action> = null

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

Methods

asImmutable

asImmutable(): this
Returns this
Inherited from Action.asImmutable

asMutable

asMutable(): this
Returns this
Inherited from Action.asMutable

clear

clear(): this
Returns this
Inherited from Action.clear

delete

delete<K extends "subActions">(key: K): this
Type Parameters
- K extends "subActions"
Parameters
- key: K
Returns this
Inherited from Action.delete

deleteIn

deleteIn(keyPath: Iterable<unknown>): this
Parameters
- keyPath: Iterable<unknown>
Returns this
Inherited from Action.deleteIn

equals

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

get

get<K extends "subActions">(
    key: K,
): {
    subActions?:
        | null
        | NutrientViewer.Immutable.List<NutrientViewer.Actions.Action>;
}[K]
Type Parameters
- K extends "subActions"
Parameters
- key: K
Returns {
    subActions?:
        | null
        | NutrientViewer.Immutable.List<NutrientViewer.Actions.Action>;
}[K]
Inherited from Action.get

getIn

getIn(keyPath: Iterable<unknown>, notSetValue?: unknown): unknown
Parameters
- keyPath: Iterable<unknown>
- OptionalnotSetValue: unknown
Returns unknown
Inherited from Action.getIn

has

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

merge

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

mergeDeep

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

mergeDeepIn

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

mergeDeepWith

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

mergeIn

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

mergeWith

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

removeIn

removeIn(keyPath: Iterable<unknown>): this
Parameters
- keyPath: Iterable<unknown>
Returns this
Inherited from Action.removeIn

set

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

setIn

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

toJS

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

toJSON

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

toSeq

toSeq(): Keyed<string, unknown>
Returns Keyed<string, unknown>
Inherited from Action.toSeq

update

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

updateIn

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

withMutations

withMutations(mutator: (mutable: this) => unknown): this
Parameters
- mutator: (mutable: this) => unknown
Returns this
Inherited from Action.withMutations

Class ResetFormAction

Example

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns NutrientViewer.Actions.ResetFormAction

Properties

fields

Default

includeExclude

Default

OptionalsubActions

Methods

asImmutable

Returns this

asMutable

Returns this

clear

Returns this

delete

Type Parameters

Parameters

Returns this

deleteIn

Parameters

Returns this

equals

Parameters

Returns boolean

get

Type Parameters

Parameters

Returns { subActions?: | null | NutrientViewer.Immutable.List<NutrientViewer.Actions.Action>;}[K]

getIn

Parameters

Returns unknown

has

Parameters

Returns boolean

merge

Parameters

Returns this

mergeDeep

Parameters

Returns this

mergeDeepIn

Parameters

Returns this

mergeDeepWith

Parameters

Returns this

mergeIn

Parameters

Returns this

mergeWith

Parameters

Returns this

removeIn

Parameters

Returns this

set

Type Parameters

Parameters

Returns this

setIn

Parameters

Returns this

toJS

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

toJSON

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

toSeq

Returns Keyed<string, unknown>

update

Type Parameters

`Optional`subActions

Returns {
subActions?:
| null
| NutrientViewer.Immutable.List<NutrientViewer.Actions.Action>;
}[K]

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

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