menu

Blazor

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class MultiSelectModel<T> - Blazor API Reference | Syncfusion

    Show / Hide Table of Contents

    Class MultiSelectModel<T>

    Defines the model for controlling all configuration, binding, event, and UI options of the Syncfusion Blazor MultiSelect component.

    Inheritance
    System.Object
    MultiSelectModel<T>
    Namespace: Syncfusion.Blazor.DropDowns
    Assembly: Syncfusion.Blazor.dll
    Syntax
    public class MultiSelectModel<T> : Object
    Type Parameters
    Name Description
    T

    The type of value(s) and items managed by MultiSelect—for example, string, int, or a specific data model.

    Remarks

    The MultiSelectModel<T> class exposes settings for item filtering, virtual scrolling, custom value/tag creation, popup templates, localization, selection logic, and all runtime events.

    Examples
    <SfMultiSelect TValue="string" DataSource="@(new List<string> { "Red", "Blue", "Green" })" Placeholder="Select a color">
      <MultiSelectEvents TValue="string" OnChange="OnChangeHandler" />
    </SfMultiSelect>

    Constructors

    MultiSelectModel()

    Declaration
    public MultiSelectModel()

    Properties

    ActionBegin

    Event arguments triggered when the MultiSelect component initiates a remote or local data fetch operation.

    Declaration
    public ActionBeginEventArgs ActionBegin { get; set; }
    Property Value
    Type Description
    ActionBeginEventArgs

    An ActionBeginEventArgs containing full request context and cancellation option.

    Remarks

    Modify properties on ActionBeginEventArgs to filter, cancel, or otherwise manipulate data fetch behavior dynamically.

    Examples

    Block server filtering for short text using Cancel.

    ActionComplete

    Event arguments triggered when a remote, async, or advanced local data load completes in MultiSelect.

    Declaration
    public ActionCompleteEventArgs ActionComplete { get; set; }
    Property Value
    Type Description
    ActionCompleteEventArgs

    An ActionCompleteEventArgs instance containing completion status, count, and the final result set.

    Remarks

    Use this event to update UI or models after remote filtering, paging, or data refresh completes.

    Examples

    Perform analytics or handle empty data after successful data load.

    ActionFailure

    Gets or sets the event callback that is triggered if a data fetch request from the remote server fails.

    Declaration
    public EventCallback<object> ActionFailure { get; set; }
    Property Value
    Type Description
    Microsoft.AspNetCore.Components.EventCallback<System.Object>

    An EventCallback<object> representing the failure callback.

    Remarks

    Use this callback to display error messages or retry failed remote fetches.

    Examples

    Listen to remote fetch failures for graceful fallback or notification UI.

    ActionFailureTemplate

    Gets or sets the string, HTML, or template to be displayed when the data fetch request from the remote server fails.

    Declaration
    public string ActionFailureTemplate { get; set; }
    Property Value
    Type Description
    System.String

    A string template shown for server or data failures. The default is "Request failed".

    Remarks

    This property helps improve user experience during network or runtime errors.

    Examples

    Show detailed error message or retry button in this template.

    AllowCustomValue

    Gets or sets a value indicating whether the MultiSelect allows custom values not present in the suggestion list.

    Declaration
    public bool AllowCustomValue { get; set; }
    Property Value
    Type Description
    System.Boolean

    true allows extra values; false is strict to available choices. The default is false.

    Remarks

    Turn on to allow user tags, chips, or unbounded entries. Useful for tagging/creation UIs.

    Examples

    Set this to true for scenarios such as free-form tags or dynamic categories.

    AllowFiltering

    Gets or sets a value indicating whether filtering is enabled in the component. Filtering action triggers as user types, and no-matches will show NoRecordsTemplate.

    Declaration
    public bool AllowFiltering { get; set; }
    Property Value
    Type Description
    System.Boolean

    true enables filtering box in MultiSelect; false disables.

    Remarks

    Recommended for large data; Default is false. Filtering can be local or remote depending on logic in Filtering event.

    Examples

    Type in MultiSelect to see filtered matches.

    BeforeOpen

    Gets or sets event arguments provided right before the MultiSelect popup is about to open.

    Declaration
    public BeforeOpenEventArgs BeforeOpen { get; set; }
    Property Value
    Type Description
    BeforeOpenEventArgs

    An BeforeOpenEventArgs instance with open state details.

    Remarks

    Use this event to dynamically cancel, position, or style the popup at open.

    Examples

    Block or configure popup on-the-fly using this event.

    Blur

    Gets or sets an event callback triggered when focus moves out of the MultiSelect component (blur event).

    Declaration
    public EventCallback<object> Blur { get; set; }
    Property Value
    Type Description
    Microsoft.AspNetCore.Components.EventCallback<System.Object>

    An EventCallback<object> to handle validation, reset, or UI effects post-blur.

    Remarks

    Useful for data validation or input correction logic triggered after focus loss.

    Examples

    Reset error state or update model on blur.

    Change

    Fires each time when the item selection changes after MultiSelect model and input values are updated.

    Declaration
    public EventCallback<object> Change { get; set; }
    Property Value
    Type Description
    Microsoft.AspNetCore.Components.EventCallback<System.Object>

    An EventCallback<object> for reacting to selection change.

    Remarks

    Attach logic for dynamic cascades, logging, or validation based on user selection.

    Examples

    Chain MultiSelect updates using this event.

    ChangeOnBlur

    Gets or sets whether the MultiSelect control fires Change event on every value addition/removal instead of only on blur.

    Declaration
    public bool ChangeOnBlur { get; set; }
    Property Value
    Type Description
    System.Boolean

    true (default) for on-change fired; false for on-blur only.

    Remarks

    This property is essential for forms that must validate or update continuously.

    Examples

    Update summary or validation each time a value is added/removed.

    ChipSelection

    Gets or sets an event callback triggered when a chip is selected in a chip-list mode MultiSelect.

    Declaration
    public EventCallback<object> ChipSelection { get; set; }
    Property Value
    Type Description
    Microsoft.AspNetCore.Components.EventCallback<System.Object>

    An EventCallback<object> for chip selection actions.

    Remarks

    Allows chip-based highlight, removal, or auxiliary UI updates.

    Examples

    Highlight or remove chips as needed on selection.

    Close

    Gets or sets an event callback raised after the popup closes post-animation.

    Declaration
    public EventCallback<object> Close { get; set; }
    Property Value
    Type Description
    Microsoft.AspNetCore.Components.EventCallback<System.Object>

    An EventCallback<object> to manage post-close logic such as UI cleanup or analytics.

    Remarks

    Executed immediately after popup closure for resource management.

    Examples

    Hide helper panels after popup closes.

    ClosePopupOnSelect

    Gets or sets a value indicating whether the popup visibility will be changed immediately after an item is selected, if enabled.

    Declaration
    public bool ClosePopupOnSelect { get; set; }
    Property Value
    Type Description
    System.Boolean

    true automatically closes after select; false keeps open. The default is true.

    Remarks

    Improves rapid-data-entry when enabled.

    Examples

    Use for tag pickers to auto-close after pick, or keep open for multi-step selection.

    Created

    Gets or sets an event callback raised upon MultiSelect component creation.

    Declaration
    public EventCallback<object> Created { get; set; }
    Property Value
    Type Description
    Microsoft.AspNetCore.Components.EventCallback<System.Object>

    An EventCallback<object> for attaching initialization or analytics logic.

    Remarks

    Great for startup logic, dynamic data binding, or analytics firing at component init.

    Examples

    Preload remote data on component initialization.

    CssClass

    Gets or sets the CSS class or classes that will be applied to the MultiSelect's root element. Useful for custom theming.

    Declaration
    public string CssClass { get; set; }
    Property Value
    Type Description
    System.String

    A string value for custom CSS classes; null by default.

    Remarks

    Combine with global or local theme CSS for visual consistency.

    Examples

    Apply custom theme, e.g. "e-my-multiselect".

    CustomValueSelection

    Gets or sets an event callback for scenarios where a custom value is selected or created.

    Declaration
    public EventCallback<object> CustomValueSelection { get; set; }
    Property Value
    Type Description
    Microsoft.AspNetCore.Components.EventCallback<System.Object>

    An EventCallback<object> for custom entry logic.

    Remarks

    Enables tag-creation or addition of user-defined values not present in the source list.

    Examples

    Enable tagging or chip-creation experiences with this event.

    DataBound

    Gets or sets arguments for when the component data binding is completed.

    Declaration
    public DataBoundEventArgs DataBound { get; set; }
    Property Value
    Type Description
    DataBoundEventArgs

    A DataBoundEventArgs containing success and content details post-bind.

    Remarks

    Attach loading indicators or post-load UI setup here.

    Examples

    Visualize all fetched items in a log after data binding completes.

    DataSource

    Gets or sets the data source that provides list items for the MultiSelect component. May be a plain array, collection, or data manager instance.

    Declaration
    public object DataSource { get; set; }
    Property Value
    Type Description
    System.Object

    Strongly-typed data items or data manager. Null by default.

    Remarks

    Allows both client-side and remote data sources for item lists.

    Examples

    Bind to local array or remote DataManager source.

    DelimiterChar

    Gets or sets the delimiter character for default and delimiter visual modes.

    Declaration
    public string DelimiterChar { get; set; }
    Property Value
    Type Description
    System.String

    A string containing the delimiter character. Default is ",".

    Remarks

    This character is used to split values for view and submission when in delimiter mode.

    Examples

    Use semicolon or pipe for special integrations as needed.

    Destroyed

    Gets or sets the event callback for logic triggered when the MultiSelect component is destroyed.

    Declaration
    public EventCallback<object> Destroyed { get; set; }
    Property Value
    Type Description
    Microsoft.AspNetCore.Components.EventCallback<System.Object>

    An EventCallback<object> for teardown, analytics, or cleanup routines.

    Remarks

    Free global resources, clear event subscriptions, or analyze end-of-life state with this event.

    Examples

    Send analytics hit or release resources on destroy.

    Enabled

    Gets or sets whether the MultiSelect control is enabled or disabled.

    Declaration
    public bool Enabled { get; set; }
    Property Value
    Type Description
    System.Boolean

    true means input is active; false disables interaction. Default: true.

    Remarks

    Use false to lock the control for readonly or process states.

    Examples

    Prevent input during busy state or workflow restrictions.

    EnableGroupCheckBox

    Gets or sets a value indicating whether grouped list items can be checked via their group header in checkbox mode.

    Declaration
    public bool EnableGroupCheckBox { get; set; }
    Property Value
    Type Description
    System.Boolean

    true enables group header checkboxes. Default: false.

    Remarks

    This allows mass selection within grouped categories for speed.

    Examples

    Enable group-header checks for category-based user interfaces.

    EnablePersistence

    Gets or sets whether the state of the MultiSelect should persist between page reloads or app restarts. When enabled, the Value is preserved.

    Declaration
    public bool EnablePersistence { get; set; }
    Property Value
    Type Description
    System.Boolean

    true will persist state; false won't. Default is false.

    Remarks

    Persists state in browser storage for modern app scenarios.

    Examples

    Maintain user choices after page reload with this feature.

    EnableRtl

    Gets or sets whether the MultiSelect control is rendered in right-to-left (RTL) direction.

    Declaration
    public bool EnableRtl { get; set; }
    Property Value
    Type Description
    System.Boolean

    true enables RTL; false disables. Default is false.

    Remarks

    Applies RTL layout for languages such as Arabic or Hebrew.

    Examples

    Right-align content for RTL applications with this setting.

    EnableSelectionOrder

    Gets or sets a value indicating whether selected items in the popup display are reordered for visual consistency.

    Declaration
    public bool EnableSelectionOrder { get; set; }
    Property Value
    Type Description
    System.Boolean

    true keeps selection order consistent; false disables. Default is true.

    Remarks

    Enables features like keeping favorites visible even among reodering.

    Examples

    Use in large lists to prioritize frequently used selections visually.

    EnableVirtualization

    Gets or sets a value indicating whether virtual scrolling is enabled or not.

    Declaration
    public bool EnableVirtualization { get; set; }
    Property Value
    Type Description
    System.Boolean

    true for virtualization (very large lists); false for standard lists. Default is false.

    Remarks

    The Virtual Scrolling feature is used to display a large amount of data without buffering the entire load of a huge database records in DropDowns. Dynamic requests fetch segments as the user scrolls.

    Examples

    Enable for 1000+ record datasets with lazy loading.

    Fields

    Gets or sets field mapping settings for the data table columns; these map text, value, icon, and group fields for list items.

    Declaration
    public FieldSettingsModel Fields { get; set; }
    Property Value
    Type Description
    FieldSettingsModel

    A FieldSettingsModel instance, or null for auto-detect.

    Remarks

    Supports advanced binding scenarios for multi-property data.

    Examples

    Map "Name" to text and "Id" to value for data models.

    FilterBarPlaceholder

    Gets or sets the text for the filter bar's placeholder within the MultiSelect popup.

    Declaration
    public string FilterBarPlaceholder { get; set; }
    Property Value
    Type Description
    System.String

    String placeholder text for the filter bar; null for no placeholder.

    Remarks

    Improves usability for mobile/desktop with long lists.

    Examples

    Guide your users: e.g. "Type to search colors".

    Filtering

    Gets or sets an event callback for every character typed in the MultiSelect's filter input box.

    Declaration
    public EventCallback<object> Filtering { get; set; }
    Property Value
    Type Description
    Microsoft.AspNetCore.Components.EventCallback<System.Object>

    An EventCallback<object> that can trigger API queries or custom filtering as user types.

    Remarks

    This callback is vital for typeahead filtering and advanced search integrations.

    Examples

    Dynamically load remote results as user types for blazing-fast search.

    FilterType

    Gets or sets the filter match type: StartsWith, Contains, etc.

    Declaration
    public FilterType FilterType { get; set; }
    Property Value
    Type Description
    FilterType

    Type of filter matching for suggestions. The default is StartsWith.

    Remarks

    Controls how user input matches candidate list items.

    Examples

    Set to Contains for substring searching.

    FloatLabelType

    Gets or sets the floating label behavior above the MultiSelect input, supporting Always, Auto, or Never. Controlled via FloatLabelType values.

    Declaration
    public FloatLabelType FloatLabelType { get; set; }
    Property Value
    Type Description
    FloatLabelType

    A FloatLabelType controlling label UI.

    Remarks

    Always: Label floats above on focus, Never: label remains hidden, Auto: context-driven float.

    Examples

    Always float label for accessibility or brand guidelines.

    Focus

    Gets or sets an event callback for logic needed when the MultiSelect control gains focus.

    Declaration
    public EventCallback<object> Focus { get; set; }
    Property Value
    Type Description
    Microsoft.AspNetCore.Components.EventCallback<System.Object>

    An EventCallback<object> for contextual highlighting or input cue logic.

    Remarks

    Use this event for advanced keyboard accessibility or input hints.

    Examples

    Show overlay tips as soon as MultiSelect is focused.

    FooterTemplate

    Gets or sets the template or markup to appear in the MultiSelect popup's footer area.

    Declaration
    public string FooterTemplate { get; set; }
    Property Value
    Type Description
    System.String

    String HTML/template for the footer, or null for none.

    Remarks

    Useful for batch actions, branding, or additional information areas below list.

    Examples

    Use "Total: {Count}" to show running tally.

    GroupTemplate

    Gets or sets the template or markup for rendering group headers in the MultiSelect popup list.

    Declaration
    public string GroupTemplate { get; set; }
    Property Value
    Type Description
    System.String

    String markup for group header template; null for none.

    Remarks

    Allows custom icons or grouping data for enhanced visual layouts.

    Examples

    Style category headers differently in dropdown lists.

    HeaderTemplate

    Gets or sets the template or markup for rendering the header container in the MultiSelect popup list.

    Declaration
    public string HeaderTemplate { get; set; }
    Property Value
    Type Description
    System.String

    String value for the popup header; null for no header.

    Remarks

    Used for branding, informational banners, or extra filtering UI above the list.

    Examples

    Show a logo in the header for branded lists.

    HideSelectedItem

    Gets or sets a value indicating whether selected items should be hidden from the item list after selection.

    Declaration
    public bool HideSelectedItem { get; set; }
    Property Value
    Type Description
    System.Boolean

    true (default) to hide selected in popup; false keeps them visible.

    Remarks

    Helps users focus on available rather than chosen items in the list.

    Examples

    Use to support "pick-and-remove" UI for faster selection in large datasets.

    HtmlAttributes

    Gets or sets a dictionary or set of additional input HTML attributes for the root MultiSelect element.

    Declaration
    public object HtmlAttributes { get; set; }
    Property Value
    Type Description
    System.Object

    Attributes object (anonymous, dictionary, etc.); null for none.

    Remarks

    If both the property and equivalent HTML attribute are configured, the property value takes precedence.

    Examples

    Add data-attributes, aria roles, or accessibility tags as needed.

    IgnoreAccent

    Gets or sets a value indicating whether the filter operation ignores diacritic (accented) characters.

    Declaration
    public bool IgnoreAccent { get; set; }
    Property Value
    Type Description
    System.Boolean

    true (accent insensitive); false is strict. Default is false.

    Remarks

    Set for multi-lingual/multi-accent lists with accent-insensitive matching.

    Examples

    Enable for normalized search across international input.

    IgnoreCase

    Gets or sets a value indicating whether the filtering is case-insensitive (default) or case-sensitive.

    Declaration
    public bool IgnoreCase { get; set; }
    Property Value
    Type Description
    System.Boolean

    true for case-insensitive filtering; false is strict. Default is true.

    Remarks

    This property is essential for search across flexible or fixed case environments.

    Examples

    Lower all input for matching if true.

    ItemTemplate

    Gets or sets the template for how each popup list item is rendered.

    Declaration
    public string ItemTemplate { get; set; }
    Property Value
    Type Description
    System.String

    String for item template/markup. Null by default.

    Remarks

    Allows rich, styled, or iconified content per-list entry.

    Examples

    Use avatars, badges, or complex layouts for each option.

    Locale

    Gets or sets the global locale to use for language/culture-specific strings in the MultiSelect component.

    Declaration
    public string Locale { get; set; }
    Property Value
    Type Description
    System.String

    The locale identifier, such as "en-US" (default).

    Remarks

    Overrides global app locale for this MultiSelect only.

    Examples

    Switch MultiSelect to "es-ES" or "zh-CN" as needed.

    MaximumSelectionLength

    Gets or sets the maximum allowed count of selections in the MultiSelect component.

    Declaration
    public int MaximumSelectionLength { get; set; }
    Property Value
    Type Description
    System.Int32

    Maximum integer selection count; default is 1000.

    Remarks

    Prevents user overload or excessive server posts.

    Examples

    Limit to 5 for tightly-bound form scenarios.

    Mode

    Gets or sets the interaction mode for the MultiSelect control: Default for normal, Delimiter for chip/delimiter, etc.

    Declaration
    public VisualMode Mode { get; set; }
    Property Value
    Type Description
    VisualMode

    The VisualMode enum value (default is VisualMode.Default).

    Remarks

    Drives the display (classic, delimiter, chip) mode for visual/UX customization.

    Examples

    Use delimiter mode for tag cloud-style interfaces.

    NoRecordsTemplate

    Gets or sets the string, HTML, or template to be displayed when there are no items in the data source.

    Declaration
    public string NoRecordsTemplate { get; set; }
    Property Value
    Type Description
    System.String

    String/markup template shown for empty-list scenarios. Default is "No records found".

    Remarks

    Improve feedback during empty search or startup loads.

    Examples

    Show empty state message or add button for new data.

    Open

    Gets or sets an event callback fired after popup opens post-animation completion.

    Declaration
    public EventCallback<object> Open { get; set; }
    Property Value
    Type Description
    Microsoft.AspNetCore.Components.EventCallback<System.Object>

    An EventCallback<object> for UI changes, logging, or analytics on popup open.

    Remarks

    Great for popup animation-driven experiences or on-open suggestions.

    Examples

    Display onboarding messages or data summaries on popup open.

    OpenOnClick

    Gets or sets whether to open the popup automatically when the control is clicked.

    Declaration
    public bool OpenOnClick { get; set; }
    Property Value
    Type Description
    System.Boolean

    true auto-opens; false requires explicit open logic. Default is true.

    Remarks

    Auto-open improves single-click flow in most applications.

    Examples

    Disable for super-compact forms or step-based workflows.

    Placeholder

    Gets or sets the hint or placeholder text that appears in the MultiSelect input until the user enters or selects a value.

    Declaration
    public string Placeholder { get; set; }
    Property Value
    Type Description
    System.String

    A string for the placeholder; null by default.

    Remarks

    Depends on FloatLabelType for visual display mode.

    Examples

    "Pick cities..." or other instructional text as placeholder.

    PopupHeight

    Gets or sets the fixed or calculated height for the MultiSelect popup. Default is auto.

    Declaration
    public string PopupHeight { get; set; }
    Property Value
    Type Description
    System.String

    String specifying any CSS unit; null for auto-height.

    Remarks

    Allows tall/short lists or mobile-optimized resizing.

    Examples

    Shrink popup to fit mobile screens by setting height in px or vh.

    PopupWidth

    Gets or sets the width for the popup list. Can use any CSS unit or percentage.

    Declaration
    public string PopupWidth { get; set; }
    Property Value
    Type Description
    System.String

    String specifying width (px, %, rem, etc.); null for auto-width.

    Remarks

    Match input, auto, or specific design requirements for consistency.

    Examples

    "400px" for extra-wide lists or "auto" for responsive sizing.

    Query

    Gets or sets an object, string, or LINQ query to be executed along with the MultiSelect data binding/processing logic.

    Declaration
    public object Query { get; set; }
    Property Value
    Type Description
    System.Object

    Extra query object; null by default.

    Remarks

    Supports remote sorting, filtering, or custom search operations.

    Examples

    Construct custom Query for advanced scenarios.

    Readonly

    Gets or sets whether the MultiSelect control is readable only or editable by the user.

    Declaration
    public bool Readonly { get; set; }
    Property Value
    Type Description
    System.Boolean

    true disables editing; false enables user changes. Default is false.

    Remarks

    Allows the control to appear interactive but block actual changes/selection.

    Examples

    Use readonly for review-mode forms or audit scenarios.

    Removed

    Gets or sets an event callback fired after an item has been successfully removed from the MultiSelect selection.

    Declaration
    public EventCallback<object> Removed { get; set; }
    Property Value
    Type Description
    Microsoft.AspNetCore.Components.EventCallback<System.Object>

    An EventCallback<object> for post-removal logic and model update.

    Remarks

    Great for updating business rules or removing items with side effects.

    Examples

    Display toast confirming removal of a chip.

    Removing

    Gets or sets an event callback fired just before an item will be removed from the MultiSelect selection.

    Declaration
    public EventCallback<object> Removing { get; set; }
    Property Value
    Type Description
    Microsoft.AspNetCore.Components.EventCallback<System.Object>

    An EventCallback<object> for pre-removal checks, confirmation dialogs, or validation.

    Remarks

    Opportunity to block removal based on rules.

    Examples

    Open confirmation dialog to user before actual removal.

    Select

    Gets or sets an event callback for when any item in the popup is selected by user action (mouse, tap, key).

    Declaration
    public EventCallback<object> Select { get; set; }
    Property Value
    Type Description
    Microsoft.AspNetCore.Components.EventCallback<System.Object>

    An EventCallback<object> for item selection notification.

    Remarks

    Use for logging, multi-step flows, or responding to selection out-of-band.

    Examples

    Track and display what user selected in popup quickly.

    SelectAllText

    Gets or sets the select-all option text shown in the component.

    Declaration
    public string SelectAllText { get; set; }
    Property Value
    Type Description
    System.String

    String for select-all toggle; default is "select All".

    Remarks

    Customize for localized or branded messages.

    Examples

    Rename to "Select All Options" for custom implementations.

    SelectedAll

    Gets or sets an event callback for after the select-all process completes, marking all items as selected in the MultiSelect popup.

    Declaration
    public EventCallback<object> SelectedAll { get; set; }
    Property Value
    Type Description
    Microsoft.AspNetCore.Components.EventCallback<System.Object>

    An EventCallback<object> for post-select-all logic and UI sync.

    Remarks

    Useful for analytics or confirmation when all items are selected.

    Examples

    Display count or confirmation banner after select all.

    ShowClearButton

    Gets or sets whether a clear button is presented with each selected item in the MultiSelect component.

    Declaration
    public bool ShowClearButton { get; set; }
    Property Value
    Type Description
    System.Boolean

    true (default) shows clear icons for quick removal; false disables. Default: true.

    Remarks

    Improves user experience for rapid chip removal and value reset.

    Examples

    Test with and without clear buttons for UX feedback.

    ShowDropDownIcon

    Gets or sets whether the MultiSelect displays a dropdown icon/button beside the main input UI.

    Declaration
    public bool ShowDropDownIcon { get; set; }
    Property Value
    Type Description
    System.Boolean

    true enables the dropdown icon; false omits it. Default is false.

    Remarks

    Best for making input affordance obvious.

    Examples

    Visually guide users toward click interaction in touch devices.

    ShowSelectAll

    Gets or sets a value indicating whether to show the select-all option on the component UI for instant multi-selection.

    Declaration
    public bool ShowSelectAll { get; set; }
    Property Value
    Type Description
    System.Boolean

    true enables 'select-all' UI element; false disables. Default is false.

    Remarks

    Often used in permission, tag, or bulk-edit scenarios.

    Examples

    Enable select all when large batch selection is a frequent scenario.

    SortOrder

    Gets or sets the sort order (None, Ascending, Descending) for arranging list or chip items.

    Declaration
    public SortOrder SortOrder { get; set; }
    Property Value
    Type Description
    SortOrder

    The SortOrder for UI arrangement. The default is SortOrder.None.

    Remarks

    Controls logical or visual sequence of items/chips in popup or input.

    Examples

    Change order to "Descending" for reverse listing of options.

    Tagging

    Gets or sets an event callback before a selected item is set as a chip (tag) in the MultiSelect UI.

    Declaration
    public EventCallback<object> Tagging { get; set; }
    Property Value
    Type Description
    Microsoft.AspNetCore.Components.EventCallback<System.Object>

    An EventCallback<object> for tagging logic or chip customization.

    Remarks

    Use to add CSS classes, restrict tags, or attach custom visuals to chips.

    Examples

    Color-code chips or inject icons with this event.

    Text

    Gets or sets the property name for the field that provides the label text of each MultiSelect item.

    Declaration
    public string Text { get; set; }
    Property Value
    Type Description
    System.String

    String that is mapped to the option's display text. Null by default.

    Remarks

    Applies to local, remote, or mapped data sources for flexible displays.

    Examples

    Set to "FullName" to display full contact names in employee lists.

    UnSelectAllText

    Gets or sets the label text used to toggle clearing all items in the component.

    Declaration
    public string UnSelectAllText { get; set; }
    Property Value
    Type Description
    System.String

    String for clear-all UI; default is "select All".

    Remarks

    Customize to "Clear All" or another suitable label as desired.

    Examples

    Make clear all semantic for accessibility guidance.

    Value

    Gets or sets the currently selected value, which is mapped to the data source Value field.

    Declaration
    public T Value { get; set; }
    Property Value
    Type Description
    T

    The T value of the currently selected item or items.

    Remarks

    This property can be used for both single and multi-value scenarios.

    Examples

    Track selected value changes using this property for two-way binding.

    ValueTemplate

    Gets or sets the template or markup to be rendered for selected value(s) in the input box.

    Declaration
    public string ValueTemplate { get; set; }
    Property Value
    Type Description
    System.String

    String value template for presenting the selection(s) inside the MultiSelect input; null for default rendering.

    Remarks

    Allows chip/avatar/badge, or just plain text, as needed by application.

    Examples

    Provide dynamic avatars as value templates for professional/corporate contacts.

    Width

    Gets or sets the width for the MultiSelect control; can be absolute or relative (%, px, rem, etc).

    Declaration
    public string Width { get; set; }
    Property Value
    Type Description
    System.String

    String indicating width; null for content auto-width.

    Remarks

    Resize to match context or breakpoints as needed for UI design.

    Examples

    "100%" for fluid layout, "300px" for fixed width, etc.

    ZIndex

    Gets or sets the z-index value that controls the stack order for the MultiSelect popup overlay.

    Declaration
    public double ZIndex { get; set; }
    Property Value
    Type Description
    System.Double

    Numeric double for z-index; default is 1000.

    Remarks

    Adjust for overlays in complex app layouts or modals.

    Examples

    Increase to 2000+ for modals or dialogs that need to overlay other controls.

    Back to top Generated by DocFX
    Copyright © 2001 - 2025 Syncfusion Inc. All Rights Reserved