Syncfusion.EJ2
Properties  Methods 


MultiSelect Class Members

The following tables list the members exposed by MultiSelect.

Public Constructors
 NameDescription
Public Constructor  
Top
Public Properties
 NameDescription
Public Property Triggers before fetching data from the remote server.  
Public Property Triggers after data is fetched successfully from the remote server.  
Public Property Triggers when the data fetch request from the remote server fails.  
Public Property Accepts the template and assigns it to the popup list content of the MultiSelect component when the data fetch request from the remote server fails.  
Public Property Allows user to add a [`custom value`](../../multi-select/custom-value), the value which is not present in the suggestion list.  
Public Property To enable the filtering option in this component. Filter action performs when type in search box and collect the matched item through `filtering` event. If searching character does not match, `noRecordsTemplate` property value will be shown.  
Public Property Fires when popup opens before animation.  
Public Property Event triggers when the input get focus-out.  
Public Property Fires each time when selection changes happened in list items after model and input value get affected.  
Public Property By default, the multiselect component fires the change event while focus out the component. If you want to fires the change event on every value selection and remove, then disable the changeOnBlur property.  
Public Property Event triggers when the chip selection.  
Public Property Fires when popup close after animation completion.  
Public Property Based on the property, when item get select popup visibility state will changed.  
Public Property Triggers when the component is created.  
Public Property Sets the CSS classes to root element of this component which helps to customize the complete styles.  
Public Property Triggers when the [`customValue`](../../multi-select/custom-value) is selected.  
Public Property Triggers when data source is populated in the popup list..  
Public Property Accepts the list items either through local or remote service and binds it to the MultiSelect component. It can be an array of JSON Objects or an instance of `DataManager`.  
Public Property Sets the delimiter character for 'default' and 'delimiter' visibility modes.  
Public Property Triggers when the component is destroyed.  
Public Property Specifies a value that indicates whether the MultiSelect component is enabled or not.  
Public Property Specifies a Boolean value that indicates the whether the grouped list items are allowed to check by checking the group header in checkbox mode. By default, there is no checkbox provided for group headers. This property allows you to render checkbox for group headers and to select all the grouped items at once  
Public Property Enable or disable persisting MultiSelect component's state between page reloads. If enabled, following list of states will be persisted. 1. value  
Public Property Enable or disable rendering component in right to left direction.  
Public Property Reorder the selected items in popup visibility state.  
Public Property The `fields` property maps the columns of the data table and binds the data to the component. text - Maps the text column from data table for each list item. value - Maps the value column from data table for each list item. iconCss - Maps the icon class column from data table for each list item. groupBy - Group the list items with it's related items by mapping groupBy field.  
Public Property Accepts the value to be displayed as a watermark text on the filter bar.  
Public Property Triggers event,when user types a text in search box. > For more details about filtering, refer to [`Filtering`](../../multi-select/filtering) documentation.  
Public Property Determines on which filter type, the MultiSelect component needs to be considered on search action. The `FilterType` and its supported data types are  
Public Property Specifies whether to display the floating label above the input element. Possible values are: Never: The label will never float in the input when the placeholder is available. Always: The floating label will always float above the input. Auto: The floating label will float above the input after focusing or entering a value in the input.  
Public Property Event triggers when the input get focused.  
Public Property Accepts the template design and assigns it to the footer container of the popup list. > For more details about the available template options refer to [`Template`](../../multi-select/templates) documentation.  
Public Property Accepts the template design and assigns it to the group headers present in the MultiSelect popup list.  
Public Property Accepts the template design and assigns it to the header container of the popup list. > For more details about the available template options refer to [`Template`](../../multi-select/templates) documentation.  
Public Property Hides the selected item from the list item.  
Public Property Gets or sets the additional attribute to `HtmlAttributes` property in MultiSelect, which helps to add attribute like title, name etc, input should be key value pair.  
Public Property (Inherited from Syncfusion.EJ2.EJTagHelper)
Public Property ignoreAccent set to true, then ignores the diacritic characters or accents when filtering.  
Public Property Sets [`case sensitive`](../../multi-select/filtering/#case-sensitive-filtering) option for filter operation.  
Public Property Accepts the template design and assigns it to each list item present in the popup. > For more details about the available template options refer to [`Template`](../../multi-select/templates) documentation.  
Public Property Overrides the global culture and localization value for this component. Default global culture is 'en-US'.  
Public Property Sets limitation to the value selection. based on the limitation, list selection will be prevented.  
Public Property configures visibility mode for component interaction.  
Public Property Accepts the template design and assigns it to popup list of MultiSelect component when no data is available on the component.  
Public Property Fires when popup opens after animation completion.  
Public Property Whether to automatically open the popup when the control is clicked.  
Public Property Gets or sets the placeholder in the component to display the given information in input when no item selected.  
Public Property Gets or sets the height of the popup list. By default it renders based on its list item. > For more details about the popup configuration refer to [`Popup Configuration`](../../multi-select/getting-started/#configure-the-popup-list) documentation.  
Public Property Gets or sets the width of the popup list and percentage values has calculated based on input width. > For more details about the popup configuration refer to [`Popup Configuration`](../../multi-select/getting-started/#configure-the-popup-list) documentation.  
Public Property Accepts the external `Query` which will execute along with the data processing in MultiSelect.  
Public Property Gets or sets the `readonly` to input or not. Once enabled, just you can copy or highlight the text however tab key action will perform.  
Public Property Fires after the selected item removed from the widget.  
Public Property Fires before the selected item removed from the widget.  
Public Property Triggers when an item in the popup is selected by the user either with mouse/tap or with keyboard navigation.  
Public Property Specifies the selectAllText to be displayed on the component.  
Public Property Fires after select all process completion.  
Public Property Enables close icon with the each selected item.  
Public Property Allows you to either show or hide the DropDown button on the component  
Public Property Allows you to either show or hide the selectAll option on the component.  
Public Property Specifies the `sortOrder` to sort the data source. The available type of sort orders are `None` - The data source is not sorting. `Ascending` - The data source is sorting with ascending order. `Descending` - The data source is sorting with descending order.  
Public Property Fires before set the selected item as chip in the component. > For more details about chip customization refer [`Chip Customization`](../../multi-select/chip-customization)  
Public Property Selects the list item which maps the data `text` field in the component.  
Public Property Specifies the UnSelectAllText to be displayed on the component.  
Public PropertySelects the list item which maps the data `value` field in the component. {% codeBlock src='multiselect/value/index.md' }{ endcodeBlock %}  
Public Property Accepts the template design and assigns it to the selected list item in the input element of the component. For more details about the available template options refer to [`Template`](../../multi-select/templates) documentation.  
Public Property Gets or sets the width of the component. By default, it sizes based on its parent. container dimension.  
Public Property specifies the z-index value of the component popup element.  
Top
Protected Properties
 NameDescription
Protected PropertyOverridden.   
Protected Property (Inherited from Syncfusion.EJ2.EJTagHelper)
Protected Property (Inherited from Syncfusion.EJ2.EJTagHelper)
Protected Property (Inherited from Syncfusion.EJ2.EJTagHelper)
Protected PropertyOverridden.   
Protected PropertyOverridden.   
Protected Property (Inherited from Syncfusion.EJ2.EJTagHelper)
Protected PropertyOverridden.   
Top
Public Methods
Protected Methods
 NameDescription
Protected Method (Inherited from Syncfusion.EJ2.EJTagHelper)
Top
Extension Methods
 NameDescription
Public Extension MethodOverloaded.  Iterates the index.
Top
See Also