Class SfMultiSelect<TValue, TItem>

The MultiSelect component contains a list of predefined values from which a multiple value can be chosen.

Inheritance

System.Object

SfMultiSelect<TValue, TItem>

Inherited Members

Syncfusion.Blazor.DropDowns.SfDropDownBase<TItem>.RenderListItemsAsync(System.Collections.Generic.IEnumerable<TItem>, Syncfusion.Blazor.DropDowns.FieldSettingsModel, Syncfusion.Blazor.Data.Query)

Syncfusion.Blazor.DropDowns.SfDropDownBase<TItem>.SetListDataAsync(System.Collections.Generic.IEnumerable<TItem>, Syncfusion.Blazor.DropDowns.FieldSettingsModel, Syncfusion.Blazor.Data.Query)

Syncfusion.Blazor.DropDowns.SfDropDownBase<TItem>.GetPropertyValue(System.Object, System.String)

Syncfusion.Blazor.DropDowns.SfDropDownBase<TItem>.ActionBeginAsync(System.Collections.Generic.IEnumerable<TItem>, Syncfusion.Blazor.Data.Query)

SfDropDownBase<TItem>.ActionCompleteAsync(IEnumerable<TItem>, Query)

SfDropDownBase<TItem>.ActionFailureAsync(Object)

Syncfusion.Blazor.DropDowns.SfDropDownBase<TItem>.GetQuery(Syncfusion.Blazor.Data.Query)

SfDropDownBase<TItem>.SetFields()

SfDropDownBase<TItem>.ExecuteSimpleQuery(IEnumerable<TItem>, Query)

SfDropDownBase<TItem>.CloneQuery(Query)

Syncfusion.Blazor.DropDowns.SfDropDownBase<TItem>.OnInitializedAsync()

Syncfusion.Blazor.DropDowns.SfDropDownBase<TItem>.OnParametersSetAsync()

Syncfusion.Blazor.DropDowns.SfDropDownBase<TItem>.GetDataByText(System.String, System.String)

Syncfusion.Blazor.DropDowns.SfDropDownBase<TItem>.IncrementalSearch(System.String, System.Collections.Generic.IEnumerable<TItem>, System.Nullable<System.Int32>, System.Boolean)

Syncfusion.Blazor.DropDowns.SfDropDownBase<TItem>.Search(System.String, System.Collections.Generic.IEnumerable<TItem>, System.String, System.Boolean)

SfDropDownBase<TItem>.SetItemValue(String, Type)

SfDropDownBase<TItem>.IsPrimitiveDataType()

SfDropDownBase<TItem>.AddItemsAsync(IEnumerable<TItem>, Nullable<Int32>)

SfDropDownBase<TItem>.InsertItemAsync(IEnumerable<TItem>, Nullable<Int32>, Boolean)

SfDropDownBase<TItem>.IsFilterMode()

Syncfusion.Blazor.DropDowns.SfDropDownBase<TItem>.RenderItemsAsync(System.Collections.Generic.IEnumerable<TItem>)

SfDropDownBase<TItem>.GetGroupedDataSourceAsync(IEnumerable<TItem>, SortOrder)

Syncfusion.Blazor.DropDowns.SfDropDownBase<TItem>.HighlightSearch(System.String, System.String, System.Boolean, Syncfusion.Blazor.DropDowns.FilterType)

SfDropDownBase<TItem>.ListItemCreated(ListOptions<TItem>)

SfDropDownBase<TItem>.Dispose(Boolean)

SfDropDownBase<TItem>.reflectionHelper

Syncfusion.Blazor.DropDowns.SfDropDownBase<TItem>.MainData

Syncfusion.Blazor.DropDowns.SfDropDownBase<TItem>.ListDataSource

Syncfusion.Blazor.DropDowns.SfDropDownBase<TItem>.DataId

Syncfusion.Blazor.DropDowns.SfDropDownBase<TItem>.ItemData

Syncfusion.Blazor.DropDowns.SfDropDownBase<TItem>.IsActionFailed

Syncfusion.Blazor.DropDowns.SfDropDownBase<TItem>.TotalCount

Syncfusion.Blazor.DropDowns.SfDropDownBase<TItem>.ComponentName

SfDropDownBase<TItem>.ItemTemplate

SfDropDownBase<TItem>.GroupTemplate

SfDropDownBase<TItem>.NoRecordsTemplate

SfDropDownBase<TItem>.ActionFailureTemplate

SfDropDownBase<TItem>.SortOrder

SfDropDownBase<TItem>.DataSource

SfDropDownBase<TItem>.Query

SfDropDownBase<TItem>.DuplicateQuery

SfDropDownBase<TItem>.FilterType

SfDropDownBase<TItem>.IgnoreCase

SfDropDownBase<TItem>.IgnoreAccent

SfDropDownBase<TItem>.ZIndex

SfDropDownBase<TItem>.DropDownsEditContext

SfDataBoundComponent.SetDataManager<T>(Object)

SfDataBoundComponent.OnAfterRenderAsync(Boolean)

SfDataBoundComponent.DataManager

SfDataBoundComponent.MainParent

SfBaseComponent.Dispose()

SfBaseComponent.OnObservableChange(String, Object, Boolean, NotifyCollectionChangedEventArgs)

Namespace: Syncfusion.Blazor.DropDowns

Assembly: Syncfusion.Blazor.dll

Syntax

public class SfMultiSelect<TValue, TItem> : SfDropDownBase<TItem>, IDropDowns

Type Parameters

Name	Description
TValue	Specifies the value type.
TItem	Specifies the type of SfMultiSelect.

Constructors

SfMultiSelect()

Declaration

public SfMultiSelect()

Properties

AllowCustomValue

Gets or sets a value indicating whether the MultiSelect Dropdown component allows entering custom values.

Declaration

public bool AllowCustomValue { get; set; }

Property Value

Type	Description
System.Boolean	`true` if custom values are allowed; otherwise, `false`.

AllowFiltering

Gets or sets a value indicating whether filtering is allowed in the MultiSelect Dropdown component.

Declaration

public bool AllowFiltering { get; set; }

Property Value

Type	Description
System.Boolean	`true` if filtering is allowed; otherwise, `false`.

Remarks

If the searching character does not match, the NoRecordsTemplate property value will be shown.

CssClass

Gets or sets a CSS class string to customize the appearance of the SfMultiSelect<TValue, TItem> component.

Declaration

public string CssClass { get; set; }

Property Value

Type	Description
System.String	Accepts a CSS class string separated by space to customize the appearance. The default value is `String.Empty`.

DelimiterChar

Gets or sets the delimiter character used to separate selected items in the MultiSelect Dropdown component.

Declaration

public string DelimiterChar { get; set; }

Property Value

Type	Description
System.String	The delimiter character used for item separation. The default value is ",".

EnableChangeOnBlur

Gets or sets a value indicating whether the value change should occur on blur for the MultiSelect Dropdown component.

Declaration

public bool EnableChangeOnBlur { get; set; }

Property Value

Type	Description
System.Boolean	`true` if value change occurs on blur; otherwise, `false`. The default value is `true`.

EnableCloseOnSelect

Gets or sets a value indicating whether the dropdown should close automatically after selecting an item in the MultiSelect Dropdown component.

Declaration

public bool EnableCloseOnSelect { get; set; }

Property Value

Type	Description
System.Boolean	`true` if the dropdown should close on select; otherwise, `false`.

Enabled

Gets or sets a value indicating whether the MultiSelect Dropdown component is enabled.

Declaration

public bool Enabled { get; set; }

Property Value

Type	Description
System.Boolean	`true` if the MultiSelect Dropdown component is enabled; otherwise, `false`. The default value is `true`.

EnableGroupCheckBox

Gets or sets a value indicating whether the group checkbox is enabled in the MultiSelect Dropdown component.

Declaration

public bool EnableGroupCheckBox { get; set; }

Property Value

Type	Description
System.Boolean	`true` if the group checkbox is enabled; otherwise, `false`.

Remarks

This property allows you to render checkbox for group headers and to select all the grouped items at once.

EnablePersistence

Gets or sets a value indicating whether the component's state should be persisted between page reloads.

Declaration

public bool EnablePersistence { get; set; }

Property Value

Type	Description
System.Boolean	`true` if persistence is enabled; otherwise, `false`.

EnableRtl

Gets or sets whether the right-to-left direction is enabled for the MultiSelect Dropdown component.

Declaration

public bool EnableRtl { get; set; }

Property Value

Type	Description
System.Boolean	`true`, if the right to left direction can be enabled. Otherwise, `false`. The default value is `false`.

EnableSelectionOrder

Gets or sets a value indicating whether the selection order is enabled in the MultiSelect Dropdown component.

Declaration

public bool EnableSelectionOrder { get; set; }

Property Value

Type	Description
System.Boolean	`true`, if the selection order can be enabled. Otherwise, `false`. The default value is `true`.

EnableVirtualization

Gets or sets a value indicating whether virtualization is enabled for the MultiSelect Dropdown component.

Declaration

public bool EnableVirtualization { get; set; }

Property Value

Type	Description
System.Boolean	`true` if virtualization is enabled; otherwise, `false`..

Remarks

The Virtual Scrolling feature is used to display a large amount of data that you require without buffering an entire load of huge database records in the DropDowns, that is, when scrolling, the datamanager request is sent to fetch some amount of data from the server dynamically.

FilterBarPlaceholder

Gets or sets the placeholder text displayed in the filter bar of the MultiSelect Dropdown component.

Declaration

public string FilterBarPlaceholder { get; set; }

Property Value

Type	Description
System.String	The placeholder text for the filter bar.

FloatLabelType

Gets or sets the type of floating label to be displayed in the MultiSelect Dropdown component.

Declaration

public FloatLabelType FloatLabelType { get; set; }

Property Value

Type	Description
FloatLabelType	Possible values are: `Never`: Never floats the label in the MultiSelect when the placeholder is available. `Always`: The floating label always floats above the MultiSelect. `Auto`: The floating label floats above the MultiSelect after focusing it or when entering the value in it.

FooterTemplate

Gets or sets the template to be rendered as the footer of the dropdown popup in the MultiSelect component.

Declaration

public RenderFragment FooterTemplate { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.RenderFragment	The template content. The default value in `null`

HeaderTemplate

Gets or sets the template to be rendered as the header of the dropdown popup in the MultiSelect component.

Declaration

public RenderFragment HeaderTemplate { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.RenderFragment	The template content. The default value in `null`

HideSelectedItem

Gets or sets a value indicating whether the selected item should be hidden in the popup list of the MultiSelect Dropdown component.

Declaration

public bool HideSelectedItem { get; set; }

Property Value

Type	Description
System.Boolean	`true` if the selected item should be hidden; otherwise, `false`.

HtmlAttributes

Gets or sets the HTML attributes to be applied to the MultiSelect Dropdown component.

Declaration

public Dictionary<string, object> HtmlAttributes { get; set; }

Property Value

Type	Description
System.Collections.Generic.Dictionary<System.String, System.Object>	The HTML attributes as a dictionary.

Remarks

If you configured both the property and equivalent input attribute, then the component considers the property value.

ID

Gets or sets the identifier of the MultiSelect Dropdown component.

Declaration

public string ID { get; set; }

Property Value

Type	Description
System.String	Accepts the string value.

InputAttributes

You can add the additional input attributes such as disabled, value, and more to the root element.

If you configured both the property and equivalent input attribute, then the component considers the property value.

Declaration

public Dictionary<string, object> InputAttributes { get; set; }

Property Value

Type	Description
System.Collections.Generic.Dictionary<System.String, System.Object>	A dictionary of additional input attributes for the root element of the component.

ItemsCount

Gets or sets the number of items to be fetched in the popup based on the ItemsCount when EnableVirtualization is enabled.

Declaration

public int ItemsCount { get; set; }

Property Value

Type	Description
System.Int32	An integer value representing the number of items to be fetched. The default value is `5`.

MaximumSelectionLength

Gets or sets the maximum number of items that can be selected in the MultiSelect Dropdown component.

Declaration

public int MaximumSelectionLength { get; set; }

Property Value

Type	Description
System.Int32	An integer value representing the maximum number of items that can be selected in the list. The default value is `1000`.

Mode

Gets or sets the visual mode of the MultiSelect Dropdown component.

Declaration

public VisualMode Mode { get; set; }

Property Value

Type	Description
VisualMode	The visual mode of the MultiSelect Dropdown. The default value is Default.

OpenOnClick

Gets or sets a value indicating whether the dropdown should open when the MultiSelect component is clicked.

Declaration

public bool OpenOnClick { get; set; }

Property Value

Type	Description
System.Boolean	`true` if the dropdown should open on click; otherwise, `false`. The default value is `true`.

Placeholder

Gets or sets the placeholder text to be displayed in the MultiSelect input when no items are selected.

Declaration

public string Placeholder { get; set; }

Property Value

Type	Description
System.String	Accepts the string value.

PopupHeight

Gets or sets the height of the dropdown popup in the MultiSelect component.

Declaration

public string PopupHeight { get; set; }

Property Value

Type	Description
System.String	Accepts the string value. The default value is `300px`.

PopupWidth

Gets or sets the width of the dropdown popup in the MultiSelect component.

Declaration

public string PopupWidth { get; set; }

Property Value

Type	Description
System.String	Accepts the string value. The default value is `100%`.

Readonly

Gets or sets a value indicating whether the MultiSelect component is in read-only mode.

Declaration

public bool Readonly { get; set; }

Property Value

Type	Description
System.Boolean	`true` if the MultiSelect component is read-only; otherwise, `false`. The default value is `false`.

SelectAllText

Gets or sets the text to be displayed for the "Select All" option in the MultiSelect component.

Declaration

public string SelectAllText { get; set; }

Property Value

Type	Description
System.String	Accepts the string value.

ShowClearButton

Gets or sets a value indicating whether the MultiSelect Dropdown should display a clear button to clear the selected values.

Declaration

public bool ShowClearButton { get; set; }

Property Value

Type	Description
System.Boolean	`true` if the clear button should be shown; otherwise, `false`. The default value is `true`.

ShowDropDownIcon

Gets or sets a value indicating whether the dropdown icon should be shown in the MultiSelect component.

Declaration

public bool ShowDropDownIcon { get; set; }

Property Value

Type	Description
System.Boolean	`true` if the dropdown icon should be shown; otherwise, `false`. The default value is `true`.

ShowSelectAll

Gets or sets a value indicating whether the Select All option should be shown in the MultiSelect component for the CheckBox mode.

Declaration

public bool ShowSelectAll { get; set; }

Property Value

Type	Description
System.Boolean	`true`, if the select all option should be shown. Otherwise, `false`.

TabIndex

Gets or sets the tab index of the MultiSelect component.

Declaration

public int TabIndex { get; set; }

Property Value

Type	Description
System.Int32	The tab index of the MultiSelect component. The default value is 0.

Text

Gets or sets the selected list item which maps the data Text field in the component.

Declaration

public string Text { get; set; }

Property Value

Type	Description
System.String	Accepts the string value.

UnSelectAllText

Gets or sets the text to be displayed for the Unselect All option in the MultiSelect component for the CheckBox mode.

Declaration

public string UnSelectAllText { get; set; }

Property Value

Type	Description
System.String	Accepts the string value.

Value

Gets the value of the selected item in the MultiSelect Dropdown component. This will be used with two-way binding.

Declaration

public TValue Value { get; set; }

Property Value

Type	Description
TValue	The current value of the multi select component.

ValueChanged

Gets or sets a callback that trigger when the value changes.

Declaration

public EventCallback<TValue> ValueChanged { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<TValue>	An event callback function.

ValueExpression

Specifies the expression for defining the value of the bound.

Declaration

public Expression<Func<TValue>> ValueExpression { get; set; }

Property Value

Type	Description
System.Linq.Expressions.Expression<System.Func<TValue>>

ValueTemplate

Gets or sets the customised design content and assigns it to the selected list item in the input element of the component.

Declaration

public RenderFragment<TItem> ValueTemplate { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.RenderFragment<TItem>	The template content. The default value in `null`

Width

Gets or sets the width of the MultiSelect component.

Declaration

public string Width { get; set; }

Property Value

Type	Description
System.String	Accepts the string value. The default value is `100%`.

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

Type	Name	Description
Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder	__builder

ClearAsync()

Allows you to clear the selected values from the MultiSelect component.

Declaration

public Task ClearAsync()

Returns

Type	Description
System.Threading.Tasks.Task	Task.

FilterAsync(IEnumerable<TItem>, Query, FieldSettingsModel)

To filter the data from given data source by using query.

Declaration

public Task FilterAsync(IEnumerable<TItem> dataSource, Query query = null, FieldSettingsModel fields = null)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<TItem>	dataSource	Specifies the data source.
Query	query	Specifies the query.
FieldSettingsModel	fields	Specifies the fields.

Returns

Type	Description
System.Threading.Tasks.Task	Task.

FilteringActionAsync(IEnumerable<TItem>, Query, FieldSettingsModel)

Task which specifies the filtering action.

Declaration

protected Task FilteringActionAsync(IEnumerable<TItem> dataSource, Query query, FieldSettingsModel fields)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<TItem>	dataSource	Specifies the data source.
Query	query	Specifies the query.
FieldSettingsModel	fields	Specifies the fields.

Returns

Type	Description
System.Threading.Tasks.Task	Task.

FocusAsync()

Sets the focus to the MultiSelect component for interaction.

Declaration

public Task FocusAsync()

Returns

Type	Description
System.Threading.Tasks.Task

FocusOutAsync()

Remove the focus from the MultiSelect component, if the component is in focus state.

Declaration

public Task FocusOutAsync()

Returns

Type	Description
System.Threading.Tasks.Task

GetDataByValueAsync(TValue)

Gets the array of data Object that matches the given array of values.

Declaration

public Task<List<TItem>> GetDataByValueAsync(TValue dataValue)

Parameters

Type	Name	Description
TValue	dataValue	Specifies the value(s).

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.List<TItem>>	Task.

GetItemsAsync()

Gets all the list items bound on this component.

Declaration

public Task<IEnumerable<TItem>> GetItemsAsync()

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<TItem>>	Task.

HidePopupAsync()

Hides the popup if it is in an open state.

Declaration

public Task HidePopupAsync()

Returns

Type	Description
System.Threading.Tasks.Task	Task.

RefreshDataAsync()

Refreshes the popup list items. The method is useful if the popup list item changed externally.

Declaration

public Task RefreshDataAsync()

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

SelectAllAsync(Boolean)

Based on the state parameter, entire list item will be selected/deselected.

parameter

TrueSelects entire list items.
FalseUn Selects entire list items.

Declaration

public Task SelectAllAsync(bool state)

Parameters

Type	Name	Description
System.Boolean	state	Specifies the state.

Returns

Type	Description
System.Threading.Tasks.Task	Task.

ShowPopupAsync()

Opens the popup that displays the list of items.

Declaration

public Task ShowPopupAsync()

Returns

Type	Description
System.Threading.Tasks.Task	Task.

UpdateValueAsync()

Task which updates the value.

Declaration

protected Task UpdateValueAsync()

Returns

Type	Description
System.Threading.Tasks.Task	Task.