DsPdfJS API v9.1.0

DsPdfJS API / ChoiceFieldProperties

Type Alias: ChoiceFieldProperties

ChoiceFieldProperties = FieldBaseProperties & object

Defines common properties for ComboBoxFieldProperties and ListBoxFieldProperties.

Type Declaration

commitOnSelChange?

optional commitOnSelChange: boolean

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.

defaultSelectedIndex?

optional defaultSelectedIndex: number

The index of item selected by default. Note, if both FieldBaseProperties#value and 'defaultSelectedIndex' are specified then 'defaultSelectedIndex' preffered.

items?

optional items: (ChoiceFieldItemProperties | string)[]

The list of items displayed in field.

rect?

optional rect: Rect

Defines the position and dimensions of the field on the page using a bounding rectangle.

Note: If a widget is specified via the 'widget' property, its 'rect' value takes precedence and will override this rectangle definition.

selectedIndex?

optional selectedIndex: number

The index of selected item. Note, if both FieldBaseProperties#value and 'selectedIndex' are specified then 'selectedIndex' preffered.

sort?

optional sort: boolean

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

spellCheck?

optional spellCheck: boolean

Indicating whether the text entered in the field is spell-checked.

widget?

optional widget: WidgetAnnotation | WidgetProperties

The widget annotation defining view properties of the checkbox field.