Data and Value Binding
The MultiSelect enables you to configure its predefined list of options and selected values.
To bind the MultiSelect to data, use the
data-items property of the component.
data property accepts both:
The following example demonstrates how to bind the MultiSelect to an array of primitive values.
If the MultiSelect is bound to a dataset of objects, the
textField property needs to be set and the value of the component will be an array of the selected objects.
By default, the MultiSelect compares the items by reference. To specify a field from the data object which will be used for the comparison, utilize the
dataItemKey property. The
dataItemKey property is useful when the references to the selected items which are configured in the
defaultValue property do not match their corresponding items from the
data collection. If
dataItemKey is not set and the references in
value do not correspond, the selected items will not be highlighted in the drop-down list.
To render the selected values, use the
value property of the MultiSelect. If you set the value through the
value property, hook up to the
onChange event and manually update the value of the