Class RadzenAutoComplete

An autocomplete text input component that provides real-time suggestions as users type based on a data source. RadzenAutoComplete combines a text input with a suggestion dropdown that filters and displays matching items, enabling quick selection without typing complete values. Features configurable filter operators (Contains, StartsWith, etc.) and case sensitivity, binding to any IEnumerable data source with TextProperty to specify display field, MinLength to require typing before showing suggestions, FilterDelay for debouncing, custom templates for rendering suggestion items, LoadData event for on-demand server-side filtering, textarea-style multiline input support, and option to show all items when field gains focus. Unlike dropdown, allows free-text entry and suggests matching items. The Value is the entered text, while SelectedItem provides access to the selected data object.

Inheritance

object

ComponentBase

RadzenComponent

DataBoundFormComponent<string>

RadzenAutoComplete

Implements

IComponent

IHandleEvent

IHandleAfterRender

IDisposable

IRadzenFormComponent

Inherited Members

DataBoundFormComponent<string>._view

DataBoundFormComponent<string>.OnDataChanged()

DataBoundFormComponent<string>.GetValue()

DataBoundFormComponent<string>.GetClassList(string)

DataBoundFormComponent<string>.OnContextMenu(MouseEventArgs)

DataBoundFormComponent<string>.TabIndex

DataBoundFormComponent<string>.FilterCaseSensitivity

DataBoundFormComponent<string>.FilterOperator

DataBoundFormComponent<string>.Name

DataBoundFormComponent<string>.Placeholder

DataBoundFormComponent<string>.Disabled

DataBoundFormComponent<string>.Change

DataBoundFormComponent<string>.LoadData

DataBoundFormComponent<string>.Form

DataBoundFormComponent<string>.Value

DataBoundFormComponent<string>.ValueChanged

DataBoundFormComponent<string>.IsBound

DataBoundFormComponent<string>.HasValue

DataBoundFormComponent<string>.TextProperty

DataBoundFormComponent<string>.Data

DataBoundFormComponent<string>.SearchText

DataBoundFormComponent<string>.SearchTextChanged

DataBoundFormComponent<string>.EditContext

DataBoundFormComponent<string>.FieldIdentifier

DataBoundFormComponent<string>.ValueExpression

DataBoundFormComponent<string>.FormFieldContext

DataBoundFormComponent<string>.CurrentPlaceholder

RadzenComponent.OnMouseEnter()

RadzenComponent.OnMouseLeave()

RadzenComponent.GetCssClass()

RadzenComponent.GetId()

RadzenComponent.Debounce(Func<Task>, int)

RadzenComponent.OnInitialized()

RadzenComponent.RaiseContextMenu(MouseEventArgs)

RadzenComponent.RaiseMouseEnter()

RadzenComponent.AddContextMenu()

RadzenComponent.RaiseMouseLeave()

RadzenComponent.Attributes

RadzenComponent.Element

RadzenComponent.MouseEnter

RadzenComponent.MouseLeave

RadzenComponent.ContextMenu

RadzenComponent.Culture

RadzenComponent.DefaultCulture

RadzenComponent.Style

RadzenComponent.Visible

RadzenComponent.UniqueID

RadzenComponent.JSRuntime

RadzenComponent.IsJSRuntimeAvailable

RadzenComponent.Reference

RadzenComponent.CurrentStyle

ComponentBase.OnInitializedAsync()

ComponentBase.OnParametersSet()

ComponentBase.OnParametersSetAsync()

ComponentBase.StateHasChanged()

ComponentBase.ShouldRender()

ComponentBase.OnAfterRender(bool)

ComponentBase.InvokeAsync(Action)

ComponentBase.InvokeAsync(Func<Task>)

ComponentBase.DispatchExceptionAsync(Exception)

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Radzen.Blazor

Assembly: Radzen.Blazor.dll

Syntax

public class RadzenAutoComplete : DataBoundFormComponent<string>, IComponent, IHandleEvent, IHandleAfterRender, IDisposable, IRadzenFormComponent

Examples

Basic autocomplete:

<RadzenAutoComplete @bind-Value=@customerName Data=@customers TextProperty="CompanyName" />

Autocomplete with custom filtering and delay:

<RadzenAutoComplete @bind-Value=@search Data=@products TextProperty="ProductName"
                     FilterOperator="StringFilterOperator.Contains" FilterCaseSensitivity="FilterCaseSensitivity.CaseInsensitive"
                     MinLength="2" FilterDelay="300" Placeholder="Type to search products..." />

Constructors

RadzenAutoComplete()

An autocomplete text input component that provides real-time suggestions as users type based on a data source. RadzenAutoComplete combines a text input with a suggestion dropdown that filters and displays matching items, enabling quick selection without typing complete values. Features configurable filter operators (Contains, StartsWith, etc.) and case sensitivity, binding to any IEnumerable data source with TextProperty to specify display field, MinLength to require typing before showing suggestions, FilterDelay for debouncing, custom templates for rendering suggestion items, LoadData event for on-demand server-side filtering, textarea-style multiline input support, and option to show all items when field gains focus. Unlike dropdown, allows free-text entry and suggests matching items. The Value is the entered text, while SelectedItem provides access to the selected data object.

Declaration

public RadzenAutoComplete()

Examples

Basic autocomplete:

<RadzenAutoComplete @bind-Value=@customerName Data=@customers TextProperty="CompanyName" />

Autocomplete with custom filtering and delay:

<RadzenAutoComplete @bind-Value=@search Data=@products TextProperty="ProductName"
                     FilterOperator="StringFilterOperator.Contains" FilterCaseSensitivity="FilterCaseSensitivity.CaseInsensitive"
                     MinLength="2" FilterDelay="300" Placeholder="Type to search products..." />

Fields

list

Gets list element reference.

Declaration

protected ElementReference list

Field Value

Type	Description
ElementReference

search

Gets search input reference.

Declaration

protected ElementReference search

Field Value

Type	Description
ElementReference

Properties

FilterDelay

Gets or sets the filter delay.

Declaration

[Parameter]
public int FilterDelay { get; set; }

Property Value

Type	Description
int	The filter delay.

InputAttributes

Specifies additional custom attributes that will be rendered by the input.

Declaration

[Parameter]
public IReadOnlyDictionary<string, object> InputAttributes { get; set; }

Property Value

Type	Description
IReadOnlyDictionary<string, object>	The attributes.

InputType

Gets or sets the underlying input type. This does not apply when Multiline is true.

Declaration

[Parameter]
public string InputType { get; set; }

Property Value

Type	Description
string	The input type.

MaxLength

Gets or sets the underlying max length.

Declaration

[Parameter]
public long? MaxLength { get; set; }

Property Value

Type	Description
long?	The max length value.

MinLength

Gets or sets the minimum length.

Declaration

[Parameter]
public int MinLength { get; set; }

Property Value

Type	Description
int	The minimum length.

Multiline

Gets or sets a value indicating whether this RadzenAutoComplete is multiline.

Declaration

[Parameter]
public bool Multiline { get; set; }

Property Value

Type	Description
bool	true if multiline; otherwise, false.

OpenOnFocus

Gets or sets a value indicating whether popup should open on focus. Set to false by default.

Declaration

[Parameter]
public bool OpenOnFocus { get; set; }

Property Value

Type	Description
bool	true if popup should open on focus; otherwise, false.

PopupStyle

Gets or sets the Popup height.

Declaration

[Parameter]
public string PopupStyle { get; set; }

Property Value

Type	Description
string	The number Popup height.

Query

Gets the IQueryable.

Declaration

protected override IQueryable Query { get; }

Property Value

Type	Description
IQueryable	The IQueryable.

Overrides

DataBoundFormComponent<string>.Query

SelectedItem

Gets or sets the selected item.

Declaration

[Parameter]
public object SelectedItem { get; set; }

Property Value

Type	Description
object	The selected item.

SelectedItemChanged

Gets or sets the selected item changed.

Declaration

[Parameter]
public EventCallback<object> SelectedItemChanged { get; set; }

Property Value

Type	Description
EventCallback<object>	The selected item changed.

Template

Gets or sets the template.

Declaration

[Parameter]
public RenderFragment<dynamic> Template { get; set; }

Property Value

Type	Description
RenderFragment<dynamic>	The template.

View

Gets the view - the Query with filtering applied.

Declaration

protected override IEnumerable View { get; }

Property Value

Type	Description
IEnumerable	The view.

Overrides

DataBoundFormComponent<string>.View

Methods

BuildRenderTree(RenderTreeBuilder)

An autocomplete text input component that provides real-time suggestions as users type based on a data source. RadzenAutoComplete combines a text input with a suggestion dropdown that filters and displays matching items, enabling quick selection without typing complete values. Features configurable filter operators (Contains, StartsWith, etc.) and case sensitivity, binding to any IEnumerable data source with TextProperty to specify display field, MinLength to require typing before showing suggestions, FilterDelay for debouncing, custom templates for rendering suggestion items, LoadData event for on-demand server-side filtering, textarea-style multiline input support, and option to show all items when field gains focus. Unlike dropdown, allows free-text entry and suggests matching items. The Value is the entered text, while SelectedItem provides access to the selected data object.

Declaration

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

Type	Name	Description
RenderTreeBuilder	__builder

Overrides

ComponentBase.BuildRenderTree(RenderTreeBuilder)

Dispose()

Disposes this instance.

Declaration

public override void Dispose()

Overrides

DataBoundFormComponent<string>.Dispose()

FocusAsync()

Sets the focus on the input element.

Declaration

public override ValueTask FocusAsync()

Returns

Type	Description
ValueTask

Overrides

DataBoundFormComponent<string>.FocusAsync()

GetComponentCssClass()

Gets the component CSS class.

Declaration

protected override string GetComponentCssClass()

Returns

Type	Description
string

Overrides

RadzenComponent.GetComponentCssClass()

OnAfterRenderAsync(bool)

Called on after render asynchronous.

Declaration

protected override Task OnAfterRenderAsync(bool firstRender)

Parameters

Type	Name	Description
bool	firstRender	if set to true is first render.

Returns

Type	Description
Task	Task.

Overrides

RadzenComponent.OnAfterRenderAsync(bool)

OnChange(ChangeEventArgs)

Handles the Change event.

Declaration

protected Task OnChange(ChangeEventArgs args)

Parameters

Type	Name	Description
ChangeEventArgs	args	The ChangeEventArgs instance containing the event data.

Returns

Type	Description
Task

OnFilterKeyPress(KeyboardEventArgs)

Handles the FilterKeyPress event.

Declaration

protected Task OnFilterKeyPress(KeyboardEventArgs args)

Parameters

Type	Name	Description
KeyboardEventArgs	args	The KeyboardEventArgs instance containing the event data.

Returns

Type	Description
Task

SetParametersAsync(ParameterView)

Set parameters as an asynchronous operation.

Declaration

public override Task SetParametersAsync(ParameterView parameters)

Parameters

Type	Name	Description
ParameterView	parameters	The parameters.

Returns

Type	Description
Task	A Task representing the asynchronous operation.

Overrides

DataBoundFormComponent<string>.SetParametersAsync(ParameterView)

Implements

IComponent

IHandleEvent

IHandleAfterRender

IDisposable

IRadzenFormComponent