DsPdfJS API v9.1.0

---

DsPdfJS API / ActionResetForm

Class: ActionResetForm

Represents an action that resets selected interactive form fields to their default values. If no default value is defined for a field, its value is cleared. For fields that can have no value PushButtonField, the action has no effect.

Extends

• ActionFieldsBase

Constructors

Constructor

new ActionResetForm(om): ActionResetForm

Creates a new ActionResetForm.

Parameters

om

ObjectManager

ObjectManager that controls the lifetime of the ActionResetForm.

Returns

ActionResetForm

Overrides

ActionFieldsBase.constructor

Constructor

new ActionResetForm(): ActionResetForm

Creates a new ActionResetForm.

Returns

ActionResetForm

Overrides

ActionFieldsBase.constructor

Accessors

excludeSpecifiedFields

Get Signature

get excludeSpecifiedFields(): boolean

Gets or sets a value indicating whether the fields specified by the 'fields' list should be excluded for processing. By default this property is "false", which means that the fields in the list are processed. If this property is set to "true", the fields in the list are excluded from processing.

Returns

boolean

Set Signature

set excludeSpecifiedFields(value): void

Gets or sets a value indicating whether the fields specified by the 'fields' list should be excluded for processing. By default this property is "false", which means that the fields in the list are processed. If this property is set to "true", the fields in the list are excluded from processing.

Parameters

value

boolean

Returns

void

Inherited from

ActionFieldsBase.excludeSpecifiedFields

---

fields

Get Signature

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

Gets the list of fields that should be processed or excluded from processing (depending on the value of 'excludeSpecifiedFields') by this action. An item in this list can be either a field's name specified as a "string", or the Field object itself. An empty list means that all fields are included.

See

excludeSpecifiedFields

Returns

(string | Field)[] | null

Set Signature

set fields(value): void

Gets the list of fields that should be processed or excluded from processing (depending on the value of 'excludeSpecifiedFields') by this action. An item in this list can be either a field's name specified as a "string", or the Field object itself. An empty list means that all fields are included.

See

excludeSpecifiedFields

Parameters

value

(string | Field)[] | null

Returns

void

Inherited from

ActionFieldsBase.fields

---

id

Get Signature

get id(): number

Gets the reference to the object.

Returns

number

Inherited from

ActionFieldsBase.id

---

om

Get Signature

get om(): ObjectManager

Gets the owner ObjectManager instance.

Returns

ObjectManager

Inherited from

ActionFieldsBase.om

Methods

free()

free(): void

Detaches the object from the ObjectManager and deallocates its memory, if possible.

Returns

void

Inherited from

ActionFieldsBase.free

---

rebind()

rebind(omTo): void

Rebinds the object from the current ObjectManager to the specified one.

Parameters

omTo

ObjectManager

The new ObjectManager for the object.

Returns

void

Inherited from

ActionFieldsBase.rebind