Class
TelerikAutoComplete<TItem>

The class for the Telerik AutoComplete component.

Definition

Namespace:Telerik.Blazor.Components

Assembly:Telerik.Blazor.dll

Type Parameters:

TItem

Syntax:

cs-api-definition
public class TelerikAutoComplete<TItem> : TelerikSelectBase<TItem, string>, IComponent, IHandleEvent, IHandleAfterRender, IDisposable, IPopupContainer

Inheritance: objectComponentBaseBaseComponentDataBoundComponent<TItem>TelerikSelectBase<TItem, string>TelerikAutoComplete<TItem>

Implements: IComponentIDisposableIHandleAfterRenderIHandleEventIPopupContainer

Inherited Members TelerikSelectBase<TItem, string>.OnParametersSetAsync()TelerikSelectBase<TItem, string>.OnInitializedAsync()TelerikSelectBase<TItem, string>.Dispose()TelerikSelectBase<TItem, string>.FocusAsync()TelerikSelectBase<TItem, string>.Open()TelerikSelectBase<TItem, string>.Close()TelerikSelectBase<TItem, string>.Refresh()TelerikSelectBase<TItem, string>.DebounceChangeValue(string)TelerikSelectBase<TItem, string>.CascadedEditContextTelerikSelectBase<TItem, string>.FloatingLabelTelerikSelectBase<TItem, string>.IdTelerikSelectBase<TItem, string>.ValueFieldTelerikSelectBase<TItem, string>.TextFieldTelerikSelectBase<TItem, string>.GroupFieldTelerikSelectBase<TItem, string>.HeaderTemplateTelerikSelectBase<TItem, string>.FooterTemplateTelerikSelectBase<TItem, string>.NoDataTemplateTelerikSelectBase<TItem, string>.WidthTelerikSelectBase<TItem, string>.FilterableTelerikSelectBase<TItem, string>.TitleTelerikSelectBase<TItem, string>.SubtitleTelerikSelectBase<TItem, string>.AriaLabelTelerikSelectBase<TItem, string>.AriaLabelledByTelerikSelectBase<TItem, string>.AriaDescribedByTelerikSelectBase<TItem, string>.ReadOnlyTelerikSelectBase<TItem, string>.ScrollModeTelerikSelectBase<TItem, string>.ItemHeightTelerikSelectBase<TItem, string>.PageSizeTelerikSelectBase<TItem, string>.EnabledTelerikSelectBase<TItem, string>.ValueExpressionTelerikSelectBase<TItem, string>.ValueChangedTelerikSelectBase<TItem, string>.ValueTelerikSelectBase<TItem, string>.TabIndexTelerikSelectBase<TItem, string>.AdaptiveModeTelerikSelectBase<TItem, string>.OnChangeTelerikSelectBase<TItem, string>.OnBlurTelerikSelectBase<TItem, string>.FillModeTelerikSelectBase<TItem, string>.RoundedTelerikSelectBase<TItem, string>.SizeTelerikSelectBase<TItem, string>.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

TelerikAutoComplete()

Declaration

cs-api-definition
public TelerikAutoComplete()

Properties

AutoCompletePrefixTemplate

The content of the AutoComplete prefix.

Declaration

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

Property Value

RenderFragment

AutoCompleteSettings

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

Declaration

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

Property Value

RenderFragment

AutoCompleteSuffixTemplate

The content of the AutoComplete suffix.

Declaration

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

Property Value

RenderFragment

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

MinLength

Defines minimum number of characters in the input before suggestions are displayed.

Declaration

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

Property Value

int

OnClose

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

Declaration

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

Property Value

EventCallback<AutoCompleteCloseEventArgs>

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<AutoCompleteItemRenderEventArgs<TItem>> OnItemRender { get; set; }

Property Value

Action<AutoCompleteItemRenderEventArgs<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<AutoCompleteOpenEventArgs> OnOpen { get; set; }

Property Value

EventCallback<AutoCompleteOpenEventArgs>

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<AutoCompleteReadEventArgs> OnRead { get; set; }

Property Value

EventCallback<AutoCompleteReadEventArgs>

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

ShowClearButton

Defines whether to render a clear button in the AutoComplete. Clear Button is displayed on hover when the AutoComplete 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

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, string>.OnParametersSetAsync()