Class
TelerikMultiSelect<TItem, TValue>

The class for the Telerik MultiSelect component.

Definition

Namespace:Telerik.Blazor.Components

Assembly:Telerik.Blazor.dll

Type Parameters:

TItem

TValue

Syntax:

cs-api-definition
public class TelerikMultiSelect<TItem, TValue> : TelerikSelectBase<TItem, List<TValue>>, IComponent, IHandleEvent, IHandleAfterRender, IDisposable, IPopupContainer

Inheritance: objectComponentBaseBaseComponentDataBoundComponent<TItem>TelerikSelectBase<TItem, List<TValue>>TelerikMultiSelect<TItem, TValue>

Implements: IComponentIDisposableIHandleAfterRenderIHandleEventIPopupContainer

Inherited Members TelerikSelectBase<TItem, List<TValue>>.OnParametersSetAsync()TelerikSelectBase<TItem, List<TValue>>.OnInitializedAsync()TelerikSelectBase<TItem, List<TValue>>.Dispose()TelerikSelectBase<TItem, List<TValue>>.FocusAsync()TelerikSelectBase<TItem, List<TValue>>.Open()TelerikSelectBase<TItem, List<TValue>>.Close()TelerikSelectBase<TItem, List<TValue>>.Refresh()TelerikSelectBase<TItem, List<TValue>>.DebounceChangeValue(string)TelerikSelectBase<TItem, List<TValue>>.CascadedEditContextTelerikSelectBase<TItem, List<TValue>>.FloatingLabelTelerikSelectBase<TItem, List<TValue>>.IdTelerikSelectBase<TItem, List<TValue>>.ValueFieldTelerikSelectBase<TItem, List<TValue>>.TextFieldTelerikSelectBase<TItem, List<TValue>>.GroupFieldTelerikSelectBase<TItem, List<TValue>>.HeaderTemplateTelerikSelectBase<TItem, List<TValue>>.FooterTemplateTelerikSelectBase<TItem, List<TValue>>.NoDataTemplateTelerikSelectBase<TItem, List<TValue>>.WidthTelerikSelectBase<TItem, List<TValue>>.FilterableTelerikSelectBase<TItem, List<TValue>>.TitleTelerikSelectBase<TItem, List<TValue>>.SubtitleTelerikSelectBase<TItem, List<TValue>>.AriaLabelTelerikSelectBase<TItem, List<TValue>>.AriaLabelledByTelerikSelectBase<TItem, List<TValue>>.AriaDescribedByTelerikSelectBase<TItem, List<TValue>>.ReadOnlyTelerikSelectBase<TItem, List<TValue>>.ScrollModeTelerikSelectBase<TItem, List<TValue>>.ItemHeightTelerikSelectBase<TItem, List<TValue>>.PageSizeTelerikSelectBase<TItem, List<TValue>>.EnabledTelerikSelectBase<TItem, List<TValue>>.ValueExpressionTelerikSelectBase<TItem, List<TValue>>.ValueChangedTelerikSelectBase<TItem, List<TValue>>.ValueTelerikSelectBase<TItem, List<TValue>>.TabIndexTelerikSelectBase<TItem, List<TValue>>.AdaptiveModeTelerikSelectBase<TItem, List<TValue>>.OnChangeTelerikSelectBase<TItem, List<TValue>>.OnBlurTelerikSelectBase<TItem, List<TValue>>.FillModeTelerikSelectBase<TItem, List<TValue>>.RoundedTelerikSelectBase<TItem, List<TValue>>.SizeTelerikSelectBase<TItem, List<TValue>>.ProcessingDataDataBoundComponent<TItem>.SetParametersAsync(ParameterView)DataBoundComponent<TItem>.Dispose()DataBoundComponent<TItem>.Rebind()DataBoundComponent<TItem>.DataBaseComponent.ShouldRender()BaseComponent.OnInitializedAsync()BaseComponent.InitLocalizer()BaseComponent.ThrowIfParameterIsNull(object, string)BaseComponent.HaveOptionsChanged(IDictionary<string, object>, IDictionary<string, object>)BaseComponent.GetClassString(params string[])BaseComponent.InvokeAsync<T>(string, params object[])BaseComponent.InvokeAsync<T>(string, CancellationToken, params object[])BaseComponent.InvokeVoidAsync(string, params object[])BaseComponent.InvokeComponentMethodAsync<T>(string, params object[])BaseComponent.InvokeComponentMethodAsync<T>(string, CancellationToken, params object[])BaseComponent.InvokeVoidComponentMethodAsync(string, params object[])BaseComponent.InvokeComponentVoidMethodAsync(string, object)BaseComponent.InvokeDisposeAsync()BaseComponent.StateHasChanged()BaseComponent.RootComponentBaseComponent.ClassComponentBase.OnInitialized()ComponentBase.OnParametersSet()ComponentBase.OnAfterRender(bool)ComponentBase.InvokeAsync(Action)ComponentBase.InvokeAsync(Func<Task>)

Constructors

TelerikMultiSelect()

Declaration

cs-api-definition
public TelerikMultiSelect()

Properties

AriaDescribedBy

Defines the aria-describedby attribute for the component. The default value of the attribute points to the selected tag list. By defining the aria-describedby, you are responsible for building the relationship between the input multiselect and the taglist.

Declaration

cs-api-definition
[Parameter]
public override string AriaDescribedBy { get; set; }

Property Value

string

Overrides TelerikSelectBase<TItem, List<TValue>>.AriaDescribedBy

AutoClose

Controls whether to close the component suggestion list on item selection.

Declaration

cs-api-definition
[Parameter]
public bool AutoClose { get; set; }

Property Value

bool

DebounceDelay

Time in ms between the last typed symbol and the firing of the internal oninput event. Default is 150ms.

Declaration

cs-api-definition
[Parameter]
public int DebounceDelay { get; set; }

Property Value

int

FilterOperator

Defines the filter operator. Default value is StringFilterOperator.StartsWith.

Declaration

cs-api-definition
[Parameter]
public StringFilterOperator FilterOperator { get; set; }

Property Value

StringFilterOperator

ItemTemplate

Defines the item template of the list items.

Declaration

cs-api-definition
[Parameter]
public RenderFragment<TItem> ItemTemplate { get; set; }

Property Value

RenderFragment<TItem>

LoaderShowDelay

The delay after which the loader in the suggestion list will be displayed.

Declaration

cs-api-definition
[Parameter]
public int LoaderShowDelay { get; set; }

Property Value

int

MaxAllowedTags

Controls the number of selected items that will be displayed independently. Items selected beyond this number will appear in the SummaryTag.

Declaration

cs-api-definition
[Parameter]
public int? MaxAllowedTags { get; set; }

Property Value

int?

MinLength

Defines minimum number of characters in the input before suggestions are displayed. Default value is 0.

Declaration

cs-api-definition
[Parameter]
public int MinLength { get; set; }

Property Value

int

MultiSelectPrefixTemplate

The content of the MultiSelect prefix.

Declaration

cs-api-definition
[Parameter]
public RenderFragment MultiSelectPrefixTemplate { get; set; }

Property Value

RenderFragment

MultiSelectSettings

Defines a renderfragment that contains all settings for the autocomplete. MultiSelectPopupSettings.

Declaration

cs-api-definition
[Parameter]
public RenderFragment MultiSelectSettings { get; set; }

Property Value

RenderFragment

MultiSelectSuffixTemplate

The content of the MultiSelect suffix.

Declaration

cs-api-definition
[Parameter]
public RenderFragment MultiSelectSuffixTemplate { get; set; }

Property Value

RenderFragment

OnClose

Defines the OnClose Event which is fired before the suggestion list of the AutoComplete is closed.

Declaration

cs-api-definition
[Parameter]
public EventCallback<MultiSelectCloseEventArgs> OnClose { get; set; }

Property Value

EventCallback<MultiSelectCloseEventArgs>

OnItemRender

Fires each time an item in dropdown renders. Use the event to add a custom CSS class to each dropdown item based on its value.

Declaration

cs-api-definition
[Parameter]
public Action<MultiSelectItemRenderEventArgs<TItem>> OnItemRender { get; set; }

Property Value

Action<MultiSelectItemRenderEventArgs<TItem>>

OnOpen

Defines the OnOpen Event which is fired before the suggestion list of the AutoComplete is opened.

Declaration

cs-api-definition
[Parameter]
public EventCallback<MultiSelectOpenEventArgs> OnOpen { get; set; }

Property Value

EventCallback<MultiSelectOpenEventArgs>

OnRead

Fires when the data source is read. Use this to attach your own filtering logic. Once attached, you must implement all such data source operations here, the Component will no longer perform them for you.

Declaration

cs-api-definition
[Parameter]
public EventCallback<MultiSelectReadEventArgs> OnRead { get; set; }

Property Value

EventCallback<MultiSelectReadEventArgs>

PersistFilterOnSelect

Defines whether the filter value will be preserved when selecting. Applicable when filtering is enabled and AutoClose is set to false.

Declaration

cs-api-definition
[Parameter]
public bool PersistFilterOnSelect { get; set; }

Property Value

bool

Placeholder

The hint that is shown if no there is no value.

Declaration

cs-api-definition
[Parameter]
public string Placeholder { get; set; }

Property Value

string

ShowArrowButton

Defines whether to render an arrow button for opening the MultiSelect.

Declaration

cs-api-definition
[Parameter]
public bool ShowArrowButton { get; set; }

Property Value

bool

ShowClearButton

Defines whether to render a clear button in the MultiSelect. Clear Button is displayed on hover when the MultiSelect has value.

Declaration

cs-api-definition
[Parameter]
public bool ShowClearButton { get; set; }

Property Value

bool

ShowPrefixSeparator

Defines whether the prefix separator should be shown. The default value is true.

Declaration

cs-api-definition
[Parameter]
public bool ShowPrefixSeparator { get; set; }

Property Value

bool

ShowSuffixSeparator

Defines whether the suffix separator should be shown. The default value is true.

Declaration

cs-api-definition
[Parameter]
public bool ShowSuffixSeparator { get; set; }

Property Value

bool

TagMode

Controls the tag mode of the component.

Declaration

cs-api-definition
[Parameter]
public MultiSelectTagMode TagMode { get; set; }

Property Value

MultiSelectTagMode

TagTemplate

Defines the rendering of the selected items' tags(chips).

Declaration

cs-api-definition
[Parameter]
public RenderFragment<TItem> TagTemplate { get; set; }

Property Value

RenderFragment<TItem>

TextField

Defines the TextField of the Data. Default value: "Text".

Declaration

cs-api-definition
[Parameter]
public override string TextField { get; set; }

Property Value

string

Overrides TelerikSelectBase<TItem, List<TValue>>.TextField

ValueMapper

A callback function that returns an item that corresponds to the argument value. Used in VirtualScrollingn combined with OnRead to facilitate pre-selection of items that are not currently loaded.

Declaration

cs-api-definition
[Parameter]
public Func<List<TValue>, Task<List<TItem>>> ValueMapper { get; set; }

Property Value

Func<List<TValue>, Task<List<TItem>>>

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration

cs-api-definition
protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

__builder

RenderTreeBuilder

Overrides ComponentBase.BuildRenderTree(RenderTreeBuilder)

OnAfterRenderAsync(bool)

Declaration

cs-api-definition
protected override Task OnAfterRenderAsync(bool firstRender)

Parameters

firstRender

bool

Returns

Task

Overrides BaseComponent.OnAfterRenderAsync(bool)

OnParametersSetAsync()

Declaration

cs-api-definition
protected override Task OnParametersSetAsync()

Returns

Task

Overrides TelerikSelectBase<TItem, List<TValue>>.OnParametersSetAsync()