Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ComboBoxField

Hierarchy

Index

Methods

Methods

clearItems

  • clearItems(): Promise<void>

  • Clears all the values in a list box or combo box.

    Returns Promise<void>

    void

deleteItemAt

  • deleteItemAt(index: number): Promise<void>

  • Deletes an item in a combo box or a list box.

    Parameters

    • index: number

      index.

    Returns Promise<void>

    void

getBorderColor

  • getBorderColor(): Promise<number>

  • Get field's border color.

    see

    Field

    Returns Promise<number>

    • An integer indicated border color will be returned.

getBorderStyle

  • getBorderStyle(): Promise<string>

  • Get field's border style.

    see

    Field

    Returns Promise<string>

    • Border style, should be one of 'solid','dashed','inset','beveled','underline'. Nothing will be done with invalid string

getControlsCount

  • getControlsCount(): Promise<number>

getCurItem

  • getCurItem(): Promise<any>

getDoNotSpellCheck

  • getDoNotSpellCheck(): Promise<boolean>

  • Returns Promise<boolean>

getEditable

  • getEditable(): Promise<boolean>

  • Returns Promise<boolean>

getFillColor

  • getFillColor(): Promise<number>

  • Get field's fill color.

    note

    Load all relative annotations before call this function, or wrong value will return.

    see

    [[setFilColor]]

    Returns Promise<number>

    • An integer indicated border color will be returned.

getFlags

getItemAt

  • getItemAt(index: number): Promise<undefined | FieldOption>

  • Gets the internal value of an item in a combo box or a list box.

    Parameters

    • index: number

      index. The number of items in a list can be obtained from numItems.

    Returns Promise<undefined | FieldOption>

getMultipleSelection

  • getMultipleSelection(): Promise<boolean>

getName

  • getName(): Promise<string>

  • Get form field's name(aka title).

    Returns Promise<string>

    • Form field's name

getNumItems

  • getNumItems(): Promise<number>

getType

getValue

  • getValue(): Promise<string>

insertItemAt

  • insertItemAt(cName: string, cExport: string, index: number): Promise<void>

  • Inserts a new item into a combo box or a list box.

    Parameters

    • cName: string

      The item name that will appear in the form.

    • cExport: string

      The export value of the field when this item is selected.
      If not provided, the cName is used as the export value.

    • index: number

      The index in the list at which to insert the item.
      If 0 (the default), the new item is inserted at the top of the list.
      If –1, the new item is inserted at the end of the list.

    Returns Promise<void>

    void

setBorderColor

  • setBorderColor(color: number): Promise<undefined | boolean>

setBorderStyle

  • Set field's border style(Not support signature field).

    see

    Field

    Parameters

    • style: FieldBorderStyle

      Border style, should be one of 'solid','dashed','inset','beveled'. Nothing will be done with invalid string

    Returns Promise<boolean>

setCurItem

  • setCurItem(index: number): Promise<boolean>

  • set Current item. for listbox, combobox

    Parameters

    • index: number

      . select item by index.

    Returns Promise<boolean>

    boolean

setDoNotSpellCheck

  • setDoNotSpellCheck(isDoNotSpellCheck: boolean): Promise<boolean>

  • Setting this property to true or false corresponds to unchecking or checking the Check Spelling attribute in the Options tab of the Field Properties dialog box.

    Parameters

    • isDoNotSpellCheck: boolean

      If true, spell checking is not performed on this editable text field.

    Returns Promise<boolean>

    boolean

setEditable

  • setEditable(isEditable: boolean): Promise<boolean>

  • Controls whether a combo box is editable. only for combox

    Parameters

    • isEditable: boolean

      If true, the user can type in a selection. If false, the user must choose one of the provided selections.

    Returns Promise<boolean>

    boolean

setFillColor

  • setFillColor(color: any): Promise<boolean>

  • Set field's fill color.

    Parameters

    • color: any

      An interge indecated fill color (alpha is not supported). Supported color format
      0 or ['T'] for transparent
      number, such as 0xff0000, 16711680
      PDF color array, such as ['RGB',1,1,1] which means white.
      HTML color format, such as '#ff0000', 'rgb(255,0,0)', 'rgba(255,0,0,1)'

    Returns Promise<boolean>

    boolean

setFlags

setItems

  • Sets the list of items for a combo box or a list box.

    see

    FieldOption

    Parameters

    • items: FieldOption[]

      Array An array in which each element is consist of string and export value.

    Returns Promise<void>

    void

setMultipleSelection

  • setMultipleSelection(isMultipleSelection: boolean): Promise<undefined | boolean>
  • ndicates that a list box allows a multiple selection of items. only for listbox

    Parameters

    • isMultipleSelection: boolean

      if true, indicates that a list box allow a multiple selection of items.

    Returns Promise<undefined | boolean>

    boolean

setValue

  • setValue(value: string): Promise<void>

  • Set field's value.

    Parameters

    • value: string

      Field's value to be set.

    Returns Promise<void>

    void or the set value.