MultiselectModel

actionFailureText String

Specifies the text to be displayed when a remote request fails.

Default: Error occurred in the request

allowCustom Boolean

Specifies whether the control allows user defined values which do not exist in the data source.

Default: false

allowFiltering Boolean

Specifies whether to allow the list of items to be filtered as input is entered into the search box.

Default: true

changeOnBlur Boolean

Specifies whether to fire the change event when focus is lost on the control or when the value is changed. When true, the change event is triggered when focus leaves the control. Otherwise, the change event is triggered on every value selection and removal.

Default: true

closePopupOnSelect Boolean

Specifies if the popup should be closed when an item is selected or stay open until focus is lost.

Default: true

cssClass String

Specifies CSS classes to customize the appearance of the control.

Default: null

dataStore {:} DataStore String[]

Specifies a list of items that should be bound to the control either via a local object or a remote data source.

Default: []

delimiterChar String

Specifies the text character used to separate items in the input element when multi-selection or checkboxes are enabled.

Default: ,

enabled Boolean

Specifies whether the control is enabled or disabled, disabled will prevent user interaction.

Default: true

enableGroupCheckbox Boolean

Specifies whether a checkbox should be displayed next to the group header allowing the entire group to be selected at once.

Default: true

enableHtmlSanitizer Boolean

Specifies whether to allow the rendering of untrusted HTML and JavaScript values withing the control. When true, any untrusted strings or scripts will be remote before rendering.

Default: true

enableRtl Boolean

Specifies whether to render the control in right to left direction.

Default: false

enableState Boolean

Specifies whether to persist the state of the control between page loads.

Default: false

fields ItemSettingsModel

Specifies the property mapping for the data source columns to the items in the list.

Default: { }

filterBarPlaceholder String

Specifies a placeholder for the filter search text box.

Default: null

filterType FilterType

Specifies the type of filter to be used when filter the list items.

Default: StartsWith

footerTemplate Function

Specifies a template to customize the appearance of the footer that is visible below all list items in the popup.

Default: null

groupSelected Boolean

Specifies whether selected items will be grouped at the top of the popup list or not. When true, the selected items will be grouped together at the top of the list. Otherwise, the selected items will be mixed within the popup list.

Default: true

groupTemplate Function

Specifies a template to customize the appearance of the grouping headers.

Default: null

headerTemplate Function

Specifies a template to customize the appearance of the header that is visible above all list items in the popup.

Default: null

hideSelectedItem Boolean

Specifies whether to hide the selected item in the popup list or not.

Default: true

htmlAttributes {:}

Specifies additional HTML attributes, such as title, styles, class, id, and name, in a key-value pair format that will be appended to the HTML element. If both the property and equivalent HTML attributes are configured, then the control overrides the property value with the HTML attributes.

Default: {}

ignoreAccent Boolean

Specifies whether to ignore diacritic characters when filtering the list items.

Default: false

ignoreCase Boolean

Specifies whether to ignore the case, make case-sensitive, when filtering the list items.

Default: true

itemTemplate Function

Specifies a template to customize how the individual list items are displayed in the popup.

Default: null

labelType FloatingLabelType

Specifies the condition on when to show the floating label, for example: never, always.

Default: Never

locale String

Specifies the culture and localization value for this control, overriding the globally defined value.

Default: en-US

mode String

Specifies how the selected item will be rendered in the input textbox.

Default: Default

noRecordsText String

Specifies the text to be displayed when there are no records to be displayed.

Default: No records found

openOnClick Boolean

Specifies whether to open the popup list when the control is clicked or is the drop down button must be clicked.

Default: true

placeholder String

Specifies a short description of what is expected to be within the list of items.

Default: null

popupHeight String

Specifies the height of the popup expressed in pixels.

Default: 300px

popupWidth String

Specifies the width of the popup expressed in pixels. By default, the width of the popup is the width of the control. Value can be expressed in percent or pixels.

Default: 100%

query Query

Specifies a query that will be executed against the data source before the data source results are bound to the control.

Default: null

readonly Boolean

Specifies whether the control is readonly disabling all user interaction with the control.

Default: false

selectAllText String

Specifies display text for the “Select All” checkbox in the popup.

Default: Select All

selectMaximum Number

Specifies the maximum number of items that will be allowed to be selected at once.

Default: 100

showClearButton Boolean

Specifies whether to show the clear button or not, allowing the user to clear the current value.

Default: true

showDropDownIcon Boolean

Specifies whether to show the drop down button on the right side of the control or not.

Default: false

showSelectAll Boolean

Specifies whether to show the “Select All” checkbox or not in the popup allowing all items to be selected at once.

Default: false

text String

Gets or sets the display text of the current selected list item in the control.

Default: null

unselectAllText String

Specifies display text for the “Unselect All” checkbox in the popup.

Default: Unselect All

value String

Gets or sets the value of the current selected list item in the control.

Default: null

valueTemplate Function

Specifies a template to customize how the selected item will be displayed in the textbox element of the control.

Default: null

width String Number

Specifies the width of the control. By default, the width of the control is determined by its parent container. Value can be expressed in percent or pixels.

Default: 100%

zIndex Number

Specifies the zIndex of the popup.

Default: 1000

actionBegin EmitType<ActionBeginEventArgs>

Event callback that is raised before retrieving data from the data store.

actionComplete EmitType<ActionCompleteEventArgs>

Event callback that is raised after data has been retrieved from the data store.

actionFailure EmitType<Object>

Event callback that is raised when there is a failure in retrieving data from the data store.

beforeOpen EmitType<BeforeOpenEventArgs>

Event callback that is raised before the popup opens.

beforeSelectAll EmitType<Object>

Event callback that is raised just before all items are selected.

blur EmitType<Object>

Event callback that is raised when focus leaves the control.

change EmitType<ChangeEventArgs>

Event callback that is raised when the value has changed, either by a user selecting a value or by the value property being changed.

chipSelection EmitType<Object>

Event callback that is raised when a chip is selected.

close EmitType<PopupEventArgs>

Event callback that is raised when the popup is closed.

created EmitType<CreatedEventArgs>

Event callback that is raised when the control has been created.

customValueSelection EmitType<CustomValueEventArgs>

Event callback that is raised when a custom value is selected.

dataBound EmitType<DataBoundEventArgs>

Event callback that is raised when data has been bound to the control.

destroyed EmitType<Object>

Event callback that is raised when the control has been destroyed.

filtering EmitType<FilteringEventArgs>

Event callback that is raised when the list of items is filtered by typing in the textbox.

focus EmitType<FocusEventArgs>

Event callback that is raised when the control is focused.

open EmitType<PopupEventArgs>

Event callback that is raised when the popup is opened.

removed EmitType<RemoveEventArgs>

Event callback that is raised when a selected item is removed from the textbox element.

removing EmitType<RemoveEventArgs>

Event callback that is raised before a selected item is removed from the textbox element.

select EmitType<SelectEventArgs>

Event callback that is raised when an item in the popup list is selected, either by a mouse/tap event or navigating the list using the keyboard.

selectedAll EmitType<SelectAllEventArgs>

Event callback that is raised when the select all action is triggered

tagging EmitType<TaggingEventArgs>

Event callback that is raised before the chip is created for the selected item.