MultiSelect Templates
The MultiSelect component allows you to change what is rendered in its items, header and footer through templates.
In this article:
- Item Template
- Tag Template
- Summary Tag Template
- Header Template
- Footer Template
- No Data Template
- Example
Item Template
The ItemTemplate determines how the individual items are rendered in the dropdown of the component. By default, the text from the particular suggestions is rendered.
The ItemTemplate exposes a context which represents the data item object. Cast it to the respective model type to access or render the item properties.
Using a MultiSelect ItemTemplate together with EnableCheckBoxes="true" does not remove the built-in item checkboxes.
Tag Template
The TagTemplate determines how the selected items are rendered in the main element of the component. By default, the text of the particular item is rendered inside the tag.
The TagTemplate exposes a context which represents the data item object. Cast it to the respective model type to access or render the item properties.
Summary Tag Template
The SummaryTagTemplate controls the rendering of the summary tag. The Multiselect renders a summary tag in the following cases:
- In Single Tag Mode.
- In Multiple Tag Mode—when the selected items are more than the
MaxAllowedTags.
The context of the SummaryTagTemplate is of type MultiSelectSummaryTagTemplateContext<TItem>. It provides an Items field (a List<TItem>) that contains the selected items.
Header Template
The HeaderTemplate controls the content that you can place above the list of items inside the dropdown element. It is always visible when the combobox is expanded. By default it is empty.
Footer Template
The FooterTemplate allows you to render content below the list of items inside the dropdownlist element. It is always visible when the dropdown is expanded. By default it is empty.
No Data Template
The NoDataTemplate controls the content of the popup element when the component does not have any items. By default, simply "No data" text is rendered.
Example
Using MultiSelect Templates