Class SfAutoComplete<TValue, TItem>

The AutoComplete component provides the matched suggestion list when type into the input, from which the user can select one.

Inheritance
System.Object
Syncfusion.Blazor.SfBaseComponent
SfDataBoundComponent
SfDropDownBase<TItem>
SfDropDownList<TValue, TItem>
SfComboBox<TValue, TItem>
SfAutoComplete<TValue, TItem>
Implements
Inherited Members
Syncfusion.Blazor.DropDowns.SfComboBox<TValue, TItem>.UpdateChildProperties(System.Object)
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.HideSpinner()
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.Hide()
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.ClosePopup()
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.KeyActionHandler(Syncfusion.Blazor.DropDowns.KeyActions)
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.VirtualScrollHandler()
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.CallStateHasChangedAsync()
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.HidePopup()
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.UpdateParentClass(System.String, System.String)
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.UpdateChildProperties(System.Object)
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.OnChangeEvent(System.EventArgs)
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.ChildContent
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.OnChange
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.OnInput
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.OnBlur
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.OnFocus
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.OnKeyDown
Namespace: Syncfusion.Blazor.DropDowns
Assembly: Syncfusion.Blazor.dll
Syntax
public class SfAutoComplete<TValue, TItem> : SfComboBox<TValue, TItem>, IInputBase, IDropDowns
Type Parameters
Name Description
TValue
TItem

Constructors

SfAutoComplete()

Declaration
public SfAutoComplete()

Properties

AutoCompleteParent

Declaration
protected dynamic AutoCompleteParent { get; set; }
Property Value
Type Description
System.Object

ComponentName

Declaration
protected override string ComponentName { get; set; }
Property Value
Type Description
System.String
Overrides
Syncfusion.Blazor.DropDowns.SfComboBox<TValue, TItem>.ComponentName

FilterType

Determines on which filter type, the component needs to be considered on search action.

Declaration
public override FilterType FilterType { get; set; }
Property Value
Type Description
FilterType
Overrides
Syncfusion.Blazor.DropDowns.SfDropDownBase<TItem>.FilterType

Highlight

When set to 'true', highlight the searched characters on suggested list items.

Declaration
public bool Highlight { get; set; }
Property Value
Type Description
System.Boolean

MinLength

Allows you to set the minimum search character length, the search action will perform after typed minimum characters.

Declaration
public int MinLength { get; set; }
Property Value
Type Description
System.Int32

ROOT

Declaration
protected override string ROOT { get; set; }
Property Value
Type Description
System.String
Overrides
Syncfusion.Blazor.DropDowns.SfComboBox<TValue, TItem>.ROOT

ShowClearButton

Specifies whether to show or hide the clear button.

When the clear button is clicked, `Value` properties are reset to null.

Declaration
public override bool ShowClearButton { get; set; }
Property Value
Type Description
System.Boolean
Overrides
Syncfusion.Blazor.DropDowns.SfComboBox<TValue, TItem>.ShowClearButton

ShowPopupButton

Allows you to either show or hide the popup button on the component.

Declaration
public bool ShowPopupButton { get; set; }
Property Value
Type Description
System.Boolean

SuggestionCount

Supports the specified number of list items on the suggestion popup.

Declaration
public int SuggestionCount { get; set; }
Property Value
Type Description
System.Int32

Methods

ActionBegin(IEnumerable<TItem>, Query)

Declaration
protected override Task<ActionBeginEventArgs> ActionBegin(IEnumerable<TItem> dataSource, Query query = null)
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<TItem> dataSource
Query query
Returns
Type Description
System.Threading.Tasks.Task<ActionBeginEventArgs>
Overrides
Syncfusion.Blazor.DropDowns.SfComboBox<TValue, TItem>.ActionBegin(System.Collections.Generic.IEnumerable<TItem>, Syncfusion.Blazor.Data.Query)

ActionComplete(IEnumerable<TItem>, Query)

Declaration
protected override Task ActionComplete(IEnumerable<TItem> dataSource, Query query = null)
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<TItem> dataSource
Query query
Returns
Type Description
System.Threading.Tasks.Task
Overrides
Syncfusion.Blazor.DropDowns.SfComboBox<TValue, TItem>.ActionComplete(System.Collections.Generic.IEnumerable<TItem>, Syncfusion.Blazor.Data.Query)

ActionFailure(Object)

Declaration
protected override Task ActionFailure(object args)
Parameters
Type Name Description
System.Object args
Returns
Type Description
System.Threading.Tasks.Task
Overrides
Syncfusion.Blazor.DropDowns.SfComboBox<TValue, TItem>.ActionFailure(System.Object)

BuildRenderTree(RenderTreeBuilder)

Declaration
protected override void BuildRenderTree(RenderTreeBuilder __builder)
Parameters
Type Name Description
Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder __builder
Overrides
Syncfusion.Blazor.DropDowns.SfComboBox<TValue, TItem>.BuildRenderTree(Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder)

ClearAll(EventArgs)

Declaration
protected override Task ClearAll(EventArgs args = null)
Parameters
Type Name Description
System.EventArgs args
Returns
Type Description
System.Threading.Tasks.Task
Overrides
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.ClearAll(System.EventArgs)

FocusHandler(FocusEventArgs)

Declaration
protected override Task FocusHandler(FocusEventArgs args)
Parameters
Type Name Description
Microsoft.AspNetCore.Components.Web.FocusEventArgs args
Returns
Type Description
System.Threading.Tasks.Task
Overrides
Syncfusion.Blazor.DropDowns.SfComboBox<TValue, TItem>.FocusHandler(Microsoft.AspNetCore.Components.Web.FocusEventArgs)

GetQuery(Query)

Declaration
protected override Query GetQuery(Query query)
Parameters
Type Name Description
Query query
Returns
Type Description
Query
Overrides
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.GetQuery(Syncfusion.Blazor.Data.Query)

HighLightSearch(String, Boolean, FilterType, String)

Highlight the searched characters on suggested list items

highlight the list item. performing the search text based on casing Determines on which filter type, the highlight text update on the text Higlighted the char based on hightligh text and this is optional. If not provide the highlightText, it wil get the filter value. Returns highlight string
Declaration
public string HighLightSearch(string textValue, bool ignoreCase, FilterType filtertype, string highLighText = null)
Parameters
Type Name Description
System.String textValue
System.Boolean ignoreCase
FilterType filtertype
System.String highLighText
Returns
Type Description
System.String

InvokeBeforeOpen()

Declaration
protected override Task<BeforeOpenEventArgs> InvokeBeforeOpen()
Returns
Type Description
System.Threading.Tasks.Task<BeforeOpenEventArgs>
Overrides
Syncfusion.Blazor.DropDowns.SfComboBox<TValue, TItem>.InvokeBeforeOpen()

InvokeBlur()

Declaration
protected override Task InvokeBlur()
Returns
Type Description
System.Threading.Tasks.Task
Overrides
Syncfusion.Blazor.DropDowns.SfComboBox<TValue, TItem>.InvokeBlur()

InvokeChangeEvent(EventArgs)

Declaration
protected override Task InvokeChangeEvent(EventArgs args = null)
Parameters
Type Name Description
System.EventArgs args
Returns
Type Description
System.Threading.Tasks.Task
Overrides
Syncfusion.Blazor.DropDowns.SfComboBox<TValue, TItem>.InvokeChangeEvent(System.EventArgs)

InvokeCustomValueEvent()

Declaration
protected override Task<CustomValueSpecifierEventArgs<TItem>> InvokeCustomValueEvent()
Returns
Type Description
System.Threading.Tasks.Task<CustomValueSpecifierEventArgs<TItem>>
Overrides
Syncfusion.Blazor.DropDowns.SfComboBox<TValue, TItem>.InvokeCustomValueEvent()

InvokePopupEvents(Boolean)

Declaration
protected override Task<PopupEventArgs> InvokePopupEvents(bool isOpen)
Parameters
Type Name Description
System.Boolean isOpen
Returns
Type Description
System.Threading.Tasks.Task<PopupEventArgs>
Overrides
Syncfusion.Blazor.DropDowns.SfComboBox<TValue, TItem>.InvokePopupEvents(System.Boolean)

InvokeSelectEvent(TItem, EventArgs)

Declaration
protected override Task<SelectEventArgs<TItem>> InvokeSelectEvent(TItem item, EventArgs args = null)
Parameters
Type Name Description
TItem item
System.EventArgs args
Returns
Type Description
System.Threading.Tasks.Task<SelectEventArgs<TItem>>
Overrides
Syncfusion.Blazor.DropDowns.SfComboBox<TValue, TItem>.InvokeSelectEvent(TItem, System.EventArgs)

isEditTextBox()

Declaration
protected override bool isEditTextBox()
Returns
Type Description
System.Boolean
Overrides
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.isEditTextBox()

IsFilter()

Declaration
protected override bool IsFilter()
Returns
Type Description
System.Boolean
Overrides
Syncfusion.Blazor.DropDowns.SfComboBox<TValue, TItem>.IsFilter()

ListItemCreated(ListOptions<TItem>)

Declaration
protected override ListOptions<TItem> ListItemCreated(ListOptions<TItem> listItem)
Parameters
Type Name Description
ListOptions<TItem> listItem
Returns
Type Description
ListOptions<TItem>
Overrides
Syncfusion.Blazor.DropDowns.SfDropDownBase<TItem>.ListItemCreated(Syncfusion.Blazor.DropDowns.ListOptions<TItem>)

OnAfterRenderAsync(Boolean)

Declaration
protected override Task OnAfterRenderAsync(bool firstRender)
Parameters
Type Name Description
System.Boolean firstRender
Returns
Type Description
System.Threading.Tasks.Task
Overrides
Syncfusion.Blazor.DropDowns.SfComboBox<TValue, TItem>.OnAfterRenderAsync(System.Boolean)

OnInitializedAsync()

Declaration
protected override Task OnInitializedAsync()
Returns
Type Description
System.Threading.Tasks.Task
Overrides
Syncfusion.Blazor.DropDowns.SfComboBox<TValue, TItem>.OnInitializedAsync()

SearchList(KeyboardEventArgs)

Declaration
protected override Task SearchList(KeyboardEventArgs args = null)
Parameters
Type Name Description
Microsoft.AspNetCore.Components.Web.KeyboardEventArgs args
Returns
Type Description
System.Threading.Tasks.Task
Overrides
Syncfusion.Blazor.DropDowns.SfComboBox<TValue, TItem>.SearchList(Microsoft.AspNetCore.Components.Web.KeyboardEventArgs)

UpdateFocusItem(TItem)

Declaration
protected override Task UpdateFocusItem(TItem focusItem = null)
Parameters
Type Name Description
TItem focusItem
Returns
Type Description
System.Threading.Tasks.Task
Overrides
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.UpdateFocusItem(TItem)

UpdateMainData()

Declaration
protected override void UpdateMainData()
Overrides
Syncfusion.Blazor.DropDowns.SfComboBox<TValue, TItem>.UpdateMainData()

Implements