Options
Menu

Class UpListboxUnorderedControl

Extension of the Listbox control that shown as an unordered list in the browser.

Hierarchy

  • SelectMainControl
    • UpListboxUnorderedControl

Index

Properties

Accessors

Methods

Properties

element

element: HTMLSelectElement

Accessors

multiple

  • get multiple(): boolean

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

    Returns boolean

required

  • get required(): boolean
  • set required(value: boolean): void

  • Check if input is required.

    Returns boolean

  • Set input to required / not required.

    Parameters

    • value: boolean

    Returns void

Methods

checkValidity

  • checkValidity(): Promise<ValidationInfo>

  • Checks the controls validity.

    Returns Promise<ValidationInfo>

deselectEntries

  • deselectEntries(entries: JQuery<HTMLElement> | string[], fireOnchange?: boolean): void

  • Deselects given entries.

    Parameters

    • entries: JQuery<HTMLElement> | string[]
    • Optional fireOnchange: boolean

      Triggers the onchange event.

    Returns void

getDisplayValue

  • getDisplayValue(): null | string | string[]

  • 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.

getEntries

  • getEntries(dataName?: string, dataValue?: string): null | JQuery<HTMLElement>

  • Returns matching entries.

    Parameters

    • Optional dataName: string
    • Optional dataValue: string

    Returns null | JQuery<HTMLElement>

getSelectedEntries

  • getSelectedEntries(): null | JQuery<HTMLElement>

  • Returns a list with all selected entries.

    Returns null | JQuery<HTMLElement>

getValue

  • getValue(): string

  • Returns string

hasValue

  • hasValue(): boolean

  • Checks if at least one option is selected from current control instance.

    Returns boolean

    It returns true when at least one option is selected.

reload

  • reload(reset: boolean): Promise<void | Error>

  • Reloads the control.

    Parameters

    • reset: boolean

      Reset the control to its first entry.

    Returns Promise<void | Error>

reset

  • reset(fireOnchange?: boolean): void

  • Deselects all entries.

    Parameters

    • Optional fireOnchange: boolean

      Triggers the onchange event.

    Returns void

selectAllEntries

  • selectAllEntries(fireOnchange?: boolean): void

  • Selects all entries.

    Parameters

    • Optional fireOnchange: boolean

      Triggers the onchange event.

    Returns void

selectEntries

  • selectEntries(entries: JQuery<HTMLElement> | string[], fireOnchange?: boolean): void

  • Selects given entries.

    Parameters

    • entries: JQuery<HTMLElement> | string[]
    • Optional fireOnchange: boolean

      Triggers the onchange event.

    Returns void

selectFirstEntry

  • selectFirstEntry(): void

  • Selects the first entry.

    Returns void

setDisplayValue

  • setDisplayValue(value: string | string[], settings?: { triggerOnchange: "disabled" | "strict" | "always" }): 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: "disabled" | "strict" | "always" }
      • triggerOnchange: "disabled" | "strict" | "always"

    Returns void

setRequired

  • setRequired(value: boolean): void

  • Sets the control required or not required.

    Parameters

    • value: boolean

    Returns void

setValue

  • setValue(value: string | string[], settings?: { triggerOnchange: "disabled" | "strict" | "always" }): void

  • Set value of the control.

    • can be asynchronous, depending on the control type.

    Parameters

    • value: string | string[]

      The value to be set.

    • Optional settings: { triggerOnchange: "disabled" | "strict" | "always" }
      • triggerOnchange: "disabled" | "strict" | "always"

    Returns void

triggerOnchange

  • triggerOnchange(): void

  • Dispatches the onchange event.

    Returns void