Enhanced list selection featuring improved responsiveness, intuitive keyboard navigation and a more user-friendly interface.

Note

This control operates the same way on both edit and view pages. Refer to this documentation for guidance on its use on view pages as well.

Hierarchy

  • UpDataEditControl
    • Multiselect

Accessors

  • get max(): number
  • Gets the maximum allowed selected items of the control.

    Returns number

    Example

    var multiselect = ix.api.dom.getControl("<GUID>");
    multiselect.max;
  • set max(value): void
  • Sets the maximum allowed selected items of the control.

    Parameters

    • value: number

    Returns void

    Example

    var multiselect = ix.api.dom.getControl("<GUID>");
    multiselect.max = 5;
  • get min(): number
  • Gets the minimum required selected items of the control.

    Returns number

    Example

    var multiselect = ix.api.dom.getControl("<GUID>");
    multiselect.min;
  • set min(value): void
  • Sets the minimum required selected items of the control.

    Parameters

    • value: number

    Returns void

    Example

    var multiselect = ix.api.dom.getControl("<GUID>");
    multiselect.min = 5;
  • get opened(): boolean
  • Gets the opened state of the control.

    Returns boolean

    Example

    var multiselect = ix.api.dom.getControl("<GUID>");
    multiselect.opened;
  • set opened(opened): void
  • Sets the opened state of the control.

    Parameters

    • opened: boolean

    Returns void

    Example

    var multiselect = ix.api.dom.getControl("<GUID>");
    multiselect.opened = <true|false>;
  • get required(): boolean
  • Gets the required state of the control.

    Returns boolean

    Example

    var multiselect = ix.api.dom.getControl("<GUID>");
    multiselect.required;
  • set required(required): void
  • Sets the required state of the control.

    Parameters

    • required: boolean

    Returns void

    Example

    var multiselect = ix.api.dom.getControl("<GUID>");
    multiselect.required = <true|false>;

Methods

  • Deselect all records.

    Returns void

    Example

    var multiselect = ix.api.dom.getControl("<GUID>");
    multiselect.deselectAll();
  • Deselects a specific record by the given record ID.

    Parameters

    • recordId: string

      The ID of the record to deselect

    Returns void

    Example

    var multiselect = ix.api.dom.getControl("<GUID>");
    multiselect.deselectRecord("<recordId>");
  • Gets the loading state of the control.

    Returns boolean

    Example

    var multiselect = ix.api.dom.getControl("<GUID>");
    multiselect.finishedLoading();
  • Get the filter value of the list.

    Returns string

    Example

    var multiselect = ix.api.dom.getControl("<GUID>");
    multiselect.getFilterValue();
  • Gets all selected records.

    Returns string[]

    An array of selected record ids or an empty array

    Example

    var multiselect = ix.api.dom.getControl("<GUID>");
    multiselect.getValue();

    // return value with two selected records
    ["1", "2"]
  • Checks if the control is valid.

    • min
    • max
    • required

    Returns boolean

    Example

    var multiselect = ix.api.dom.getControl("<GUID>");
    multiselect.isValid();
  • Reloads the list.

    • selected records won't be touched.

    Parameters

    • Optional oHtmlFilter: HTMLInputElement

    Returns void

    Example

    var multiselect = ix.api.dom.getControl("<GUID>");
    multiselect.reload();
  • Select all records.

    Returns void

    Example

    var multiselect = ix.api.dom.getControl("<GUID>");
    multiselect.selectAll();
  • Filters the list with the specified value.

    Parameters

    • filterValue: string = ""

      Value to filter. Leave parameter empty to reset the value.

    Returns void

    Example

    var multiselect = ix.api.dom.getControl("<GUID>");
    multiselect.setFilterValue("<filterValue>");
  • Selects all records by the given IDs.

    Parameters

    • recordId: string | string[]

      Single ID or array of record IDs to select

    • Optional settings: {
          attr: {
              strModus?: string;
          };
      }
      • attr: {
            strModus?: string;
        }
        • Optional strModus?: string

    Returns void

    Example

    var multiselect = ix.api.dom.getControl("<GUID>");

    // set single value
    multiselect.setValue("<recordId>");

    // set multiple values
    multiselect.setValue(["<recordIdOne>", "<recordIdTwo>"]);

    // replace selected value(s)
    multiselect.setValue(["<recordIdOne>", "<recordIdTwo>"],{attr:{strModus:"replace"}});
  • Changes the state, whether only selected entries are displayed or all.

    Parameters

    • onlySelected: boolean = true

    Returns void

    Example

    var multiselect = ix.api.dom.getControl("<GUID>");
    multiselect.showOnlySelected(<true|false>);