ListBoxField

DsPdfJS API v9.1.0

DsPdfJS API / ListBoxField

Class: ListBoxField

Represents the ListBox field.

Extends

ChoiceField

Constructors

Constructor

new ListBoxField(om): ListBoxField

Creates a new ListBoxField.

Parameters

om

ObjectManager

ObjectManager that controls the lifetime of the ListBoxField.

Returns

ListBoxField

Overrides

ChoiceField.constructor

Constructor

new ListBoxField(): ListBoxField

Creates a new ListBoxField.

Returns

ListBoxField

Overrides

ChoiceField.constructor

Accessors

alternateName

Get Signature

get alternateName(): string | null

Gets or sets an alternate field name to be used in place of the actual field name wherever the field must be identified in the user interface (such as in error or status messages referring to the field). This text is also useful when extracting the document's contents in support of accessibility to users with disabilities or for other purposes.

Returns

string | null

Set Signature

set alternateName(value): void

Parameters

value

string | null

Returns

void

Inherited from

ChoiceField.alternateName

calculationIndex

Get Signature

get calculationIndex(): number

Gets or sets an index that is used to determine the field's calculation order. Fields with lower indices are calculated before fields with higher indices.

If several fields have the same CalculationIndex, the calculation order is determined by the order of fields in the collection.

recalculateValue can be used to specify JavaScript that is used to calculate the field's value.

Returns

number

Set Signature

set calculationIndex(value): void

Gets or sets an index that is used to determine the field's calculation order. Fields with lower indices are calculated before fields with higher indices.

If several fields have the same CalculationIndex, the calculation order is determined by the order of fields in the collection.

recalculateValue can be used to specify JavaScript that is used to calculate the field's value.

Parameters

value

number

Returns

void

Inherited from

ChoiceField.calculationIndex

children

Get Signature

get children(): FieldCollection

Gets the list of child fields.

Returns

FieldCollection

Inherited from

ChoiceField.children

commitOnSelChange

Get Signature

get commitOnSelChange(): boolean

Gets or sets a value indicating whether the new value is committed as soon as a selection is made with the pointing device. This option enables applications to perform an action once a selection is made, without requiring the user to exit the field. If false, the new value is not committed until the user exits the field.

Returns

boolean

Set Signature

set commitOnSelChange(value): void

Parameters

value

boolean

Returns

void

Inherited from

ChoiceField.commitOnSelChange

defaultSelectedIndex

Get Signature

get defaultSelectedIndex(): number

Gets or sets the index of item selected by default.

Returns

number

Set Signature

set defaultSelectedIndex(value): void

Gets or sets the index of item selected by default.

Parameters

value

number

Returns

void

Inherited from

ChoiceField.defaultSelectedIndex

defaultSelectedIndexes

Get Signature

get defaultSelectedIndexes(): number[] | null

Gets or sets the indexes of default selected items.

Returns

number[] | null

Set Signature

set defaultSelectedIndexes(value): void

Gets or sets the indexes of default selected items.

Parameters

value

number[] | null

Returns

void

defaultValue

Get Signature

get defaultValue(): string | number | boolean | number[] | null

Gets or sets the field's default value.

Returns

string | number | boolean | number[] | null

Set Signature

set defaultValue(value): void

Gets or sets the field's default value.

Parameters

value

string | number | boolean | number[] | null

Returns

void

Inherited from

ChoiceField.defaultValue

doc

Get Signature

get doc(): PdfDocument | null

Gets the PdfDocument owning this field.

Returns

PdfDocument | null

Inherited from

ChoiceField.doc

export

Get Signature

get export(): boolean

Gets or sets a value indicating whether the field must not be exported by a ActionSubmitForm action.

Returns

boolean

Set Signature

set export(value): void

Gets or sets a value indicating whether the field must not be exported by a ActionSubmitForm action.

Parameters

value

boolean

Returns

void

Inherited from

ChoiceField.export

formatValue

Get Signature

get formatValue(): ActionJavaScript | null

Gets or sets a JavaScript action to be performed before the field is formatted to display its current value. This action can modify the field's value before formatting.

Returns

ActionJavaScript | null

Set Signature

set formatValue(value): void

Gets or sets a JavaScript action to be performed before the field is formatted to display its current value. This action can modify the field's value before formatting.

Parameters

value

ActionJavaScriptProperties | ActionJavaScript | null

Returns

void

Inherited from

ChoiceField.formatValue

id

Get Signature

get id(): number

Gets the reference to the object.

Returns

number

Inherited from

ChoiceField.id

items

Get Signature

get items(): (string | ChoiceFieldItemProperties)[]

Gets the list of items displayed in field.

Returns

(string | ChoiceFieldItemProperties)[]

Set Signature

set items(value): void

Gets the list of items displayed in field.

Parameters

value

(string | ChoiceFieldItemProperties)[] | null

Returns

void

Inherited from

ChoiceField.items

justification

Get Signature

get justification(): VariableTextJustification | null

Gets or sets the justification to be used in displaying the field's text. Note that this field is used only if WidgetAnnotation#justification is not specified.

Returns

VariableTextJustification | null

Set Signature

set justification(value): void

Gets or sets the justification to be used in displaying the field's text. Note that this field is used only if WidgetAnnotation#justification is not specified.

Parameters

value

VariableTextJustification | null

Returns

void

Inherited from

ChoiceField.justification

keyPress

Get Signature

get keyPress(): ActionJavaScript | null

Gets or sets a JavaScript action to be performed when the user types a keystroke into a text field or combo box or modifies the selection in a scrollable list box. This action can check the keystroke for validity and reject or modify it.

Returns

ActionJavaScript | null

Set Signature

set keyPress(value): void

Parameters

value

ActionJavaScriptProperties | ActionJavaScript | null

Returns

void

Inherited from

ChoiceField.keyPress

mappingName

Get Signature

get mappingName(): string | null

Gets or sets the mapping name to be used when exporting interactive form field data from the document.

Returns

string | null

Set Signature

set mappingName(value): void

Gets or sets the mapping name to be used when exporting interactive form field data from the document.

Parameters

value

string | null

Returns

void

Inherited from

ChoiceField.mappingName

multiSelect

Get Signature

get multiSelect(): boolean

Gets or sets a value indicating whether more than one of the field's option items may be selected simultaneously.

Returns

boolean

Set Signature

set multiSelect(value): void

Gets or sets a value indicating whether more than one of the field's option items may be selected simultaneously.

Parameters

value

boolean

Returns

void

name

Get Signature

get name(): string | null

Gets or sets the field's name.

Returns

string | null

Set Signature

set name(value): void

Gets or sets the field's name.

Parameters

value

string

Returns

void

Inherited from

ChoiceField.name

om

Get Signature

get om(): ObjectManager

Gets the owner ObjectManager instance.

Returns

ObjectManager

Inherited from

ChoiceField.om

owner

Get Signature

get owner(): FieldCollection | null

Gets the FieldCollection containing this field.

Returns

FieldCollection | null

Inherited from

ChoiceField.owner

parent

Get Signature

get parent(): Field | null

Gets the parent field.

Returns

Field | null

Inherited from

ChoiceField.parent

readOnly

Get Signature

get readOnly(): boolean

Gets or sets a value indicating whether the user may not change the value of the field. Any associated widget annotations will not interact with the user; that is, they will not respond to mouse clicks or change their appearance in response to mouse motions. This flag is useful for fields whose values are computed or imported from a database.

Returns

boolean

Set Signature

set readOnly(value): void

Parameters

value

boolean

Returns

void

Inherited from

ChoiceField.readOnly

recalculateValue

Get Signature

get recalculateValue(): ActionJavaScript | null

Gets or sets a JavaScript action to be performed to recalculate the value of this field when that of another field changes.

Returns

ActionJavaScript | null

Set Signature

set recalculateValue(value): void

Gets or sets a JavaScript action to be performed to recalculate the value of this field when that of another field changes.

Parameters

value

ActionJavaScriptProperties | ActionJavaScript | null

Returns

void

Inherited from

ChoiceField.recalculateValue

rect

Get Signature

get rect(): Rect

Gets or sets the rectangle that defines the location and size of the field on a page. This property wraps the WidgetAnnotation#rect property and functions identically to: this.widget.rect = value;

Note that a field may have multiple associated annotations across different pages. These can be added and configured using the @widgets property.

See

WidgetAnnotation#rect

Returns

Rect

Set Signature

set rect(value): void

Gets or sets the rectangle that defines the location and size of the field on a page. This property wraps the WidgetAnnotation#rect property and functions identically to: this.widget.rect = value;

Note that a field may have multiple associated annotations across different pages. These can be added and configured using the @widgets property.

See

WidgetAnnotation#rect

Parameters

value

Rect

Returns

void

Inherited from

ChoiceField.rect

required

Get Signature

get required(): boolean

Gets or sets a value indicating whether the field must have a value at the time it is exported by a ActionSubmitForm action.

Returns

boolean

Set Signature

set required(value): void

Gets or sets a value indicating whether the field must have a value at the time it is exported by a ActionSubmitForm action.

Parameters

value

boolean

Returns

void

Inherited from

ChoiceField.required

selectedIndex

Get Signature

get selectedIndex(): number

Gets or sets the index of selected item.

Returns

number

Set Signature

set selectedIndex(value): void

Gets or sets the index of selected item.

Parameters

value

number

Returns

void

Inherited from

ChoiceField.selectedIndex

selectedIndexes

Get Signature

get selectedIndexes(): number[] | null

Gets or sets the indexes of selected items.

Returns

number[] | null

Set Signature

set selectedIndexes(value): void

Gets or sets the indexes of selected items.

Parameters

value

number[] | null

Returns

void

sort

Get Signature

get sort(): boolean

Gets or sets a value indicating whether the field's option items should be sorted alphabetically. This flag is intended for use by form authoring tools, not by PDF viewer applications. Viewers should simply display the options in the order in which they occur in the Opt array

Returns

boolean

Set Signature

set sort(value): void

Parameters

value

boolean

Returns

void

Inherited from

ChoiceField.sort

spellCheck

Get Signature

get spellCheck(): boolean

Gets or sets a value indicating whether the text entered in the field is spell-checked.

Returns

boolean

Set Signature

set spellCheck(value): void

Gets or sets a value indicating whether the text entered in the field is spell-checked.

Parameters

value

boolean

Returns

void

Inherited from

ChoiceField.spellCheck

topIndex

Get Signature

get topIndex(): number

Gets or sets the index of top visible item.

Returns

number

Set Signature

set topIndex(value): void

Gets or sets the index of top visible item.

Parameters

value

number

Returns

void

value

Get Signature

get value(): string | number | boolean | number[] | null

Gets or sets the field's value.

Returns

string | number | boolean | number[] | null

Set Signature

set value(value): void

Gets or sets the field's value.

Parameters

value

string | number | boolean | number[] | null

Returns

void

Inherited from

ChoiceField.value

valueChanged

Get Signature

get valueChanged(): ActionJavaScript | null

Gets or sets a JavaScript action to be performed when the field's value is changed. This action can check the new value for validity.

Returns

ActionJavaScript | null

Set Signature

set valueChanged(value): void

Gets or sets a JavaScript action to be performed when the field's value is changed. This action can check the new value for validity.

Parameters

value

ActionJavaScriptProperties | ActionJavaScript | null

Returns

void

Inherited from

ChoiceField.valueChanged

Get Signature

get widget(): WidgetAnnotation

Gets the WidgetAnnotation defining view properties of the text field.

Returns

WidgetAnnotation

Inherited from

ChoiceField.widget

widgets

Get Signature

get widgets(): FieldWidgetCollection

Gets the list of widget annotations associated with this field.

Returns

FieldWidgetCollection

Inherited from

ChoiceField.widgets

Methods

free()

free(): void

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

Returns

void

Inherited from

ChoiceField.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

ChoiceField.rebind