Class TelerikMultiSelect<TItem, TValue>
The class for the Telerik MultiSelect component.
Inheritance
Inherited Members
Namespace: Telerik.Blazor.Components
Assembly: Telerik.Blazor.dll
Syntax
public class TelerikMultiSelect<TItem, TValue> : TelerikSelectBase<TItem, List<TValue>>, IDisposable, IPopupContainer, ILabelableInput
Type Parameters
TItem
|
TValue
|
Constructors
TelerikMultiSelect()
Declaration
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
public override string AriaDescribedBy { get; set; }
Property Value
System.String
|
Overrides
AutoClose
Controls whether to close the component suggestion list on item selection.
Declaration
public bool AutoClose { get; set; }
Property Value
System.Boolean
|
ClearButton
Defines whether to render a clear button in the MultiSelect. Clear Button is displayed on hover when the MultiSelect has value.
Declaration
public bool ClearButton { get; set; }
Property Value
System.Boolean
|
DebounceDelay
Time in ms between the last typed symbol and the firing of the internal oninput event. Default is 150ms.
Declaration
public int DebounceDelay { get; set; }
Property Value
System.Int32
|
FilterOperator
Defines the filter operator. Default value is StringFilterOperator.StartsWith.
Declaration
public StringFilterOperator FilterOperator { get; set; }
Property Value
StringFilterOperator
|
ItemTemplate
Defines the item template of the list items.
Declaration
public RenderFragment<TItem> ItemTemplate { get; set; }
Property Value
Microsoft.AspNetCore.Components.RenderFragment<TItem>
|
LoaderShowDelay
The delay after which the loader in the suggestion list will be displayed.
Declaration
public int LoaderShowDelay { get; set; }
Property Value
System.Int32
|
MaxAllowedTags
Controls the number of selected items that will be displayed independently. Items selected beyond this number will appear in the SummaryTag.
Declaration
public Nullable<int> MaxAllowedTags { get; set; }
Property Value
System.Nullable<System.Int32>
|
MinLength
Defines minimum number of characters in the input before suggestions are displayed. Default value is 0.
Declaration
public int MinLength { get; set; }
Property Value
System.Int32
|
MultiSelectPrefixTemplate
The content of the MultiSelect prefix.
Declaration
public RenderFragment MultiSelectPrefixTemplate { get; set; }
Property Value
Microsoft.AspNetCore.Components.RenderFragment
|
MultiSelectSettings
Defines a renderfragment that contains all settings for the autocomplete. MultiSelectPopupSettings.
Declaration
public RenderFragment MultiSelectSettings { get; set; }
Property Value
Microsoft.AspNetCore.Components.RenderFragment
|
MultiSelectSuffixTemplate
The content of the MultiSelect suffix.
Declaration
public RenderFragment MultiSelectSuffixTemplate { get; set; }
Property Value
Microsoft.AspNetCore.Components.RenderFragment
|
OnClose
Defines the OnClose Event which is fired before the suggestion list of the AutoComplete is closed.
Declaration
public EventCallback<MultiSelectCloseEventArgs> OnClose { get; set; }
Property Value
Microsoft.AspNetCore.Components.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
public Action<MultiSelectItemRenderEventArgs<TItem>> OnItemRender { get; set; }
Property Value
System.Action<MultiSelectItemRenderEventArgs<TItem>>
|
OnOpen
Defines the OnOpen Event which is fired before the suggestion list of the AutoComplete is opened.
Declaration
public EventCallback<MultiSelectOpenEventArgs> OnOpen { get; set; }
Property Value
Microsoft.AspNetCore.Components.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
public EventCallback<MultiSelectReadEventArgs> OnRead { get; set; }
Property Value
Microsoft.AspNetCore.Components.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
public bool PersistFilterOnSelect { get; set; }
Property Value
System.Boolean
|
Placeholder
The hint that is shown if no there is no value.
Declaration
public string Placeholder { get; set; }
Property Value
System.String
|
ShowArrowButton
Defines whether to render an arrow button for opening the MultiSelect.
Declaration
public bool ShowArrowButton { get; set; }
Property Value
System.Boolean
|
ShowClearButton
Defines whether to render a clear button in the MultiSelect. Clear Button is displayed on hover when the MultiSelect has value.
Declaration
public bool ShowClearButton { get; set; }
Property Value
System.Boolean
|
ShowPrefixSeparator
Defines whether the prefix separator should be shown. The default value is true.
Declaration
public bool ShowPrefixSeparator { get; set; }
Property Value
System.Boolean
|
ShowSuffixSeparator
Defines whether the suffix separator should be shown. The default value is true.
Declaration
public bool ShowSuffixSeparator { get; set; }
Property Value
System.Boolean
|
TagMode
Controls the tag mode of the component.
Declaration
public MultiSelectTagMode TagMode { get; set; }
Property Value
MultiSelectTagMode
|
TagTemplate
Defines the rendering of the selected items' tags(chips).
Declaration
public RenderFragment<TItem> TagTemplate { get; set; }
Property Value
Microsoft.AspNetCore.Components.RenderFragment<TItem>
|
TextField
Defines the TextField of the Data. Default value: "Text".
Declaration
public override string TextField { get; set; }
Property Value
System.String
|
Overrides
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
public Func<List<TValue>, Task<List<TItem>>> ValueMapper { get; set; }
Property Value
System.Func<System.Collections.Generic.List<TValue>, System.Threading.Tasks.Task<System.Collections.Generic.List<TItem>>>
|
Methods
BuildRenderTree(RenderTreeBuilder)
Declaration
protected override void BuildRenderTree(RenderTreeBuilder __builder)
Parameters
Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder
__builder
|
OnAfterRenderAsync(Boolean)
Declaration
protected override Task OnAfterRenderAsync(bool firstRender)
Parameters
System.Boolean
firstRender
|
Returns
System.Threading.Tasks.Task
|
Overrides
OnParametersSetAsync()
Declaration
protected override Task OnParametersSetAsync()
Returns
System.Threading.Tasks.Task
|