Class SfComboBox<TValue, TItem>

The ComboBox component allows the user to type a value or choose an option from the list of predefined options.

Inheritance
System.Object
Syncfusion.Blazor.SfBaseComponent
SfDataBoundComponent
SfDropDownBase<TItem>
SfDropDownList<TValue, TItem>
SfComboBox<TValue, TItem>
SfAutoComplete<TValue, TItem>
Implements
Inherited Members
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 SfComboBox<TValue, TItem> : SfDropDownList<TValue, TItem>, IInputBase, IDropDowns
Type Parameters
Name Description
TValue
TItem

Constructors

SfComboBox()

Declaration
public SfComboBox()

Properties

AllowCustom

Specifies whether the component allows user defined value which does not exist in data source.

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

Autofill

Specifies whether suggest a first matched item in input when searching. No action happens when no matches found.

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

ComboBoxParent

Declaration
protected dynamic ComboBoxParent { 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.SfDropDownList<TValue, TItem>.ComponentName

IsTyped

Declaration
protected bool IsTyped { get; set; }
Property Value
Type Description
System.Boolean

ROOT

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

ShowClearButton

Specifies whether to show or hide the clear button.

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

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

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.SfDropDownList<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.SfDropDownList<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.SfDropDownList<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.SfDropDownList<TValue, TItem>.BuildRenderTree(Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder)

CustomValue()

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

FilterInputHandler(ChangeEventArgs)

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

FocusHandler(FocusEventArgs)

Declaration
protected virtual Task FocusHandler(FocusEventArgs args)
Parameters
Type Name Description
Microsoft.AspNetCore.Components.Web.FocusEventArgs args
Returns
Type Description
System.Threading.Tasks.Task

FocusOutHandler(FocusEventArgs)

Declaration
protected Task FocusOutHandler(FocusEventArgs args = null)
Parameters
Type Name Description
Microsoft.AspNetCore.Components.Web.FocusEventArgs args
Returns
Type Description
System.Threading.Tasks.Task

IncrementSearch(KeyboardEventArgs)

Declaration
protected Task IncrementSearch(KeyboardEventArgs args)
Parameters
Type Name Description
Microsoft.AspNetCore.Components.Web.KeyboardEventArgs args
Returns
Type Description
System.Threading.Tasks.Task

InlineSearch(KeyboardEventArgs)

Declaration
protected Task InlineSearch(KeyboardEventArgs args = null)
Parameters
Type Name Description
Microsoft.AspNetCore.Components.Web.KeyboardEventArgs args
Returns
Type Description
System.Threading.Tasks.Task

InvokeBeforeOpen()

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

InvokeBlur()

Declaration
protected virtual Task InvokeBlur()
Returns
Type Description
System.Threading.Tasks.Task

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.SfDropDownList<TValue, TItem>.InvokeChangeEvent(System.EventArgs)

InvokeCustomValueEvent()

Declaration
protected virtual Task<CustomValueSpecifierEventArgs<TItem>> InvokeCustomValueEvent()
Returns
Type Description
System.Threading.Tasks.Task<CustomValueSpecifierEventArgs<TItem>>

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.SfDropDownList<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.SfDropDownList<TValue, TItem>.InvokeSelectEvent(TItem, System.EventArgs)

IsFilter()

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

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.SfDropDownList<TValue, TItem>.OnAfterRenderAsync(System.Boolean)

OnChangeHandler(ChangeEventArgs)

Declaration
protected Task OnChangeHandler(ChangeEventArgs args)
Parameters
Type Name Description
Microsoft.AspNetCore.Components.ChangeEventArgs args
Returns
Type Description
System.Threading.Tasks.Task

OnInitializedAsync()

Declaration
protected override Task OnInitializedAsync()
Returns
Type Description
System.Threading.Tasks.Task
Overrides
Syncfusion.Blazor.DropDowns.SfDropDownList<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.SfDropDownList<TValue, TItem>.SearchList(Microsoft.AspNetCore.Components.Web.KeyboardEventArgs)

SetOldValue(Object)

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

UpdateAriaAttributes()

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

UpdateAutoFillOnDown(TItem)

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

UpdateMainData()

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

UpdateValue()

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

Implements