The Listbox control offers the same functions as the Dropdown control but shows the entries as an open list in the browser.

Hierarchy

Properties

element: HTMLSelectElement

Accessors

  • get multiple(): boolean
  • Retrieves the boolean value indicating whether multiple items can be selected from a list.

    Returns boolean

  • get required(): boolean
  • Check if input is required.

    Returns boolean

  • set required(value): void
  • Set input to required / not required.

    Parameters

    • value: boolean

    Returns void

Methods

  • Checks the controls validity.

    Returns Promise<ValidationInfo>

  • Get the current value of the control.

    Returns null | string | string[]

    Display text of the selected option as string.

    • It returns null when no option is selected
    • An array containing the value of each selected option when there is at least one and it is possible to select more.
  • Checking at least one option is selected from current control instance.

    Returns boolean

    It returns true when at least one option is selected.

  • Reloads the control.

    Parameters

    • reset: boolean

      Reset the control to its first entry.

    Returns Promise<void | Error>

  • Selects the first entry.

    Parameters

    • triggerOnchange: TriggerValues = "always"

    Returns void

  • Set display value of the control by record id.

    • can be asynchronous, depending on the control type.

    Parameters

    • value: string | string[]

      The display value to be set.

    • Optional settings: {
          triggerOnchange: TriggerValues;
      }
      • triggerOnchange: TriggerValues

    Returns void

  • Set value of the control.

    • can be asynchronous, depending on the control type.

    Parameters

    • value: string | string[]

      The unformated raw value to be set.

    • Optional settings: {
          triggerOnchange: TriggerValues;
      }
      • triggerOnchange: TriggerValues

    Returns void