API Documentation for ListField

API Documentation for ListField
- NoPoDoFo ListField
- Properties
- Methods

NoPoDoFo ListField

ListField is the base class to list type acroform fields, including ComboBox and ListBox. Classes derived from ListField present users with multiple options. A user may select one or more options from fields derived from ListField.

abstract class ListField extends Field {
  selected: number
  readonly length: number
  spellCheckEnabled: boolean
  sorted: boolean
  multiSelect: boolean

  isComboBox(): boolean
  insertItem(value: string, displayName: string): void
  removeItem(index: number): void
  getItem(index: number): ListItem
}

Properties

selected

Get or set the selected list item.

length

Readonly property, returns the number of options in the field.

spellCheckEnabled

Enable or disable spellchecking

sorted

Enable of disable sorting

multiSelect

Enable or sidable multiselect

Methods

isComboBox

isComboBox(): boolean

If derived field is a ComboBox return true, else false

isComboBox(): boolean

If derived field is a ComboBox return true, else false

insertItem

insertItem(value: string, displayName: string): void

Add an item to the list of values

insertItem(value: string, displayName: string): void

Add an item to the list of values

removeItem

removeItem(index: number): void

Remove an item from the list

removeItem(index: number): void