Class SortableList

Represents a sortable list view control.

This control is ideal for scenarios where users need to view a list of items in a specific order.

Hierarchy

  • UpDataControl
    • SortableList

Implements

  • UpSortableListControl

Methods

getEntries getValue reload setValue

Methods

getEntries

  • Returns a list of the elements in the list.

    Returns HTMLLIElement[]

    Example

    var sortableListCtrl = ix.api.dom.getControl("<ELEMENT-GUID>");
    sortableListCtrl.getEntries();

getValue

  • Returns the record id of the selected entry.

    Returns string

    Example

    var sortableListCtrl = ix.api.dom.getControl("<ELEMENT-GUID>");
    sortableListCtrl.getValue();

reload

  • Reloads the sortable list.

    Returns Promise<unknown>

    Example

    var sortableListCtrl = ix.api.dom.getControl("<ELEMENT-GUID>");
    sortableListCtrl.reload();

setValue

  • Marks an element as selected and sets value in input field.

    Parameters

    • id: string | number

      Entry to mark as selected

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

      should the onchange event trigger?

      • Optional triggerOnchange?: "disabled" | "strict" | "always"

    Returns void

    Example

    var sortableListCtrl = ix.api.dom.getControl("<ELEMENT-GUID>");
    sortableListCtrl.setValue("<DATA-ITEM-KEY>");

Settings

Member Visibility

Theme

On This Page