ComboBoxField

Class: ComboBoxField

Represents the ComboBox field.

Extends

ChoiceField

Constructors

Constructor

new ComboBoxField(om): ComboBoxField;

Creates a new ComboBoxField.

Parameters

om

ObjectManager

ObjectManager that controls the lifetime of the ComboBoxField.

Returns

ComboBoxField

Overrides

ChoiceField.constructor

Constructor

new ComboBoxField(): ComboBoxField;

Creates a new ComboBoxField.

Returns

ComboBoxField

Overrides

ChoiceField.constructor

Accessors

alternateName

Get Signature

get alternateName(): string;

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

Set Signature

set alternateName(value): void;

Parameters

value

string

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

defaultText

Get Signature

get defaultText(): string;

Gets or sets the default value of this ComboBoxField as a string.

The behavior varies based on the 'editable' property:

When 'editable' is false: returns the text of the selected item from the 'items' collection
When 'editable' is true: allows getting/setting any custom string value, regardless of the 'items' collection

Returns

string

Set Signature

set defaultText(value): void;

Gets or sets the default value of this ComboBoxField as a string.

The behavior varies based on the 'editable' property:

When 'editable' is false: returns the text of the selected item from the 'items' collection
When 'editable' is true: allows getting/setting any custom string value, regardless of the 'items' collection

Parameters

value

string

Returns

void

defaultValue

Get Signature

get defaultValue(): number;

Gets or sets the default value of ComboBoxField, value is specified as index of selected item.

Returns

number

Set Signature

set defaultValue(value): void;

Gets or sets the default value of ComboBoxField, value is specified as index of selected item.

Parameters

value

number

Returns

void

Overrides

ChoiceField.defaultValue

doc

Get Signature

get doc(): PdfDocument;

Gets the PdfDocument owning this field.

Returns

PdfDocument

Inherited from

ChoiceField.doc

editable

Get Signature

get editable(): boolean;

Gets or sets a value indicating whether the combo box includes an editable text box as well as a drop-down list.

Returns

boolean

Set Signature

set editable(value): void;

Gets or sets a value indicating whether the combo box includes an editable text box as well as a drop-down list.

Parameters

value

boolean

Returns

void

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;

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

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

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)[]

Returns

void

Inherited from

ChoiceField.items

justification

Get Signature

get justification(): VariableTextJustification;

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

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

Returns

void

Inherited from

ChoiceField.justification

keyPress

Get Signature

get keyPress(): ActionJavaScript;

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

Set Signature

set keyPress(value): void;

Parameters

value

| ActionJavaScriptProperties | ActionJavaScript

Returns

void

Inherited from

ChoiceField.keyPress

mappingName

Get Signature

get mappingName(): string;

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

Returns

string

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

Returns

void

Inherited from

ChoiceField.mappingName

name

Get Signature

get name(): string;

Gets or sets the field's name.

Returns

string

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;

Gets the FieldCollection containing this field.

Returns

FieldCollection

Inherited from

ChoiceField.owner

page

Get Signature

get page(): PdfPage;

Gets or sets the PdfPage containing this field. This property wraps the WidgetAnnotation#page property and functions identically to: this.widget.page = 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#page

Returns

PdfPage

Set Signature

set page(value): void;

Gets or sets the PdfPage containing this field. This property wraps the WidgetAnnotation#page property and functions identically to: this.widget.page = 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#page

Parameters

value

PdfPage

Returns

void

Inherited from

ChoiceField.page

parent

Get Signature

get parent(): Field;

Gets the parent field.

Returns

Field

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;

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

Returns

ActionJavaScript

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

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

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

text

Get Signature

get text(): string;

Gets or sets the string value of this ComboBoxField.

The behavior varies based on the 'editable' property:

When 'editable' is false: returns the text of the selected item from the 'items' collection
When 'editable' is true: allows getting/setting any custom string value, regardless of the 'items' collection

Returns

string

Set Signature

set text(value): void;

Gets or sets the string value of this ComboBoxField.

The behavior varies based on the 'editable' property:

When 'editable' is false: returns the text of the selected item from the 'items' collection
When 'editable' is true: allows getting/setting any custom string value, regardless of the 'items' collection