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
SfBaseComponent
SfDataBoundComponent
SfDropDownBase<TItem>
SfDropDownList<TValue, TItem>
SfComboBox<TValue, TItem>
SfAutoComplete<TValue, TItem>
Implements
Syncfusion.Blazor.DropDowns.IVirtualList<TItem>
Inherited Members
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.POPUP_CONTENT
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.GROUP_BY
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.DROP_DOWN_ICON
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.DDL_HEADER
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.DDL_FOOTER
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.ARIA_LIVE
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.ARIA_ACTIVE_DESCENDANT
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.NULL_VALUE
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.ARIA_OWN
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.ARIA_CONTROLS
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.OPTIONS
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.ROLE
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.COMBO_BOX
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.AUTO_CORRECT
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.OFF
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.SPELL_CHECK
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.AUTO_COMPLETE
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.AUTO_CAPITAL
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.ARIA_EXPANDED
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.ARIA_SET_SIZE
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.SELECTED
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.ITEM_FOCUS
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.VirtualScrollRefreshAsync(Syncfusion.Blazor.DropDowns.VirtualAction)
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>.UpdateListHeight(System.Double)
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.UpdateFieldSetStatus(System.Boolean)
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.CallStateHasChangedAsync()
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.OnInitializedAsync()
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.PreRender()
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.OnParametersSetAsync()
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.OnAfterRenderAsync(System.Boolean)
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.SetOldValueAsync(System.Object, System.Boolean)
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.GetScrollValueAsync()
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.UpdateValueSelectionAsync(TItem, System.Boolean, System.Boolean)
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.SetRTL()
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.SetCssClass()
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.UpdateAriaAttributes()
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.HidePopup()
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.GetOpenEventArguments()
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.InvokePopupEventsAsync(System.Boolean)
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.InvokeClearButtonClickEventAsync(System.EventArgs, System.Boolean)
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.FilterClearAsync()
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.FilterInputHandlerAsync(Microsoft.AspNetCore.Components.ChangeEventArgs)
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.PasteHandlerAsync()
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.UpdateMainListDataAsync()
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.CheckAndResetCache()
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.FilteringActionAsync(System.Collections.Generic.IEnumerable<TItem>, Syncfusion.Blazor.Data.Query, Syncfusion.Blazor.DropDowns.FieldSettingsModel)
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.GetFilteringSkeletonCount()
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.RefreshPopupAsync(System.Boolean)
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.RefreshVirtualIndices()
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.GetQuery(Syncfusion.Blazor.Data.Query)
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.GetTakeValue()
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.GetVirtualTrackHeight()
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.GetStyles()
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.IsFilterMode()
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.InvokeOpenEventAsync()
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.InvokeClosedEventAsync()
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.CreatePopupAsync(System.Boolean)
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.ShowPopup()
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.UpdatePopupState()
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>.UpdateInputValueAsync(System.String)
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.MouseClickHandlerAsync(Syncfusion.Blazor.DropDowns.ListOptions<TItem>, Microsoft.AspNetCore.Components.Web.MouseEventArgs)
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.InvokeSelectEventAsync(TItem, System.EventArgs, Syncfusion.Blazor.DropDowns.KeyActions)
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.UpdateSelectedItemAsync(TItem, System.EventArgs, Syncfusion.Blazor.DropDowns.KeyActions)
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.UpdateSelectItemAsync(TItem, System.EventArgs, Syncfusion.Blazor.DropDowns.KeyActions)
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.UpdateListSelectionAsync(TItem, System.String)
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.SetValueAsync(Syncfusion.Blazor.DropDowns.DataItems<TValue>)
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.InvokeChangeEventAsync(System.EventArgs, Syncfusion.Blazor.DropDowns.KeyActions)
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.OnChangeEventAsync(System.EventArgs, Syncfusion.Blazor.DropDowns.KeyActions)
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.GetItemData(TItem)
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.ActionBeginAsync(System.Collections.Generic.IEnumerable<TItem>, Syncfusion.Blazor.Data.Query)
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.ActionCompleteAsync(System.Collections.Generic.IEnumerable<TItem>, Syncfusion.Blazor.Data.Query)
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.RenderEqualItemsAsync(System.Boolean)
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.ActionFailureAsync(System.Object)
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.IsEditableInput()
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.CustomValueAsync(System.Boolean, Syncfusion.Blazor.DropDowns.KeyActions)
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.UpdateAutoFillOnDownAsync(TItem)
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.UpdateFocusItemAsync(TItem)
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.UpdateValidateClass()
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.OnSearchAsync(Microsoft.AspNetCore.Components.Web.KeyboardEventArgs)
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>.DropDownListParent
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.InputBaseObject
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.FilterInputObject
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.RootElementClass
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.ContainerElementClass
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.DropdownValue
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.StopClearButtonPropagation
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.PreventContainer
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.IsDevice
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.ShowPopupList
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.PopupElement
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.PopupHolderElement
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.PopupContainer
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.IsListRendering
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.IsDropDownClick
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.IsMinimalData
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.IsMainDataUpdated
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.IsValidKey
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.IsTyped
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.IsFilterClearIconClicked
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.IsCustomFilter
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.IsFilterPrevented
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.ActiveIndex
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.ContainerElementAttribute
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.PreviousValue
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.PreviousItemData
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.TypedString
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.IsBeforePopupOpen
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.PreventAutoFillAction
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.FocusedListData
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.ComponentName
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.PreventIconHandler
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.PopupContent
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.NoDataContent
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.DropdownIcon
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.VirtualAction
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.ROOTNODECLASS
Syncfusion.Blazor.DropDowns.SfDropDownBase<TItem>.RenderListItemsAsync(System.Collections.Generic.IEnumerable<TItem>, Syncfusion.Blazor.DropDowns.FieldSettingsModel, Syncfusion.Blazor.Data.Query)
Syncfusion.Blazor.DropDowns.SfDropDownBase<TItem>.SetListDataAsync(System.Collections.Generic.IEnumerable<TItem>, Syncfusion.Blazor.DropDowns.FieldSettingsModel, Syncfusion.Blazor.Data.Query)
Syncfusion.Blazor.DropDowns.SfDropDownBase<TItem>.GetPropertyValue(System.Object, System.String)
Syncfusion.Blazor.DropDowns.SfDropDownBase<TItem>.ActionBeginAsync(System.Collections.Generic.IEnumerable<TItem>, Syncfusion.Blazor.Data.Query)
Syncfusion.Blazor.DropDowns.SfDropDownBase<TItem>.GetQuery(Syncfusion.Blazor.Data.Query)
Syncfusion.Blazor.DropDowns.SfDropDownBase<TItem>.OnInitializedAsync()
Syncfusion.Blazor.DropDowns.SfDropDownBase<TItem>.OnParametersSetAsync()
Syncfusion.Blazor.DropDowns.SfDropDownBase<TItem>.GetDataByText(System.String, System.String)
Syncfusion.Blazor.DropDowns.SfDropDownBase<TItem>.IncrementalSearch(System.String, System.Collections.Generic.IEnumerable<TItem>, System.Nullable<System.Int32>, System.Boolean)
Syncfusion.Blazor.DropDowns.SfDropDownBase<TItem>.Search(System.String, System.Collections.Generic.IEnumerable<TItem>, System.String, System.Boolean)
Syncfusion.Blazor.DropDowns.SfDropDownBase<TItem>.RenderItemsAsync(System.Collections.Generic.IEnumerable<TItem>)
Syncfusion.Blazor.DropDowns.SfDropDownBase<TItem>.HighlightSearch(System.String, System.String, System.Boolean, Syncfusion.Blazor.DropDowns.FilterType)
Syncfusion.Blazor.DropDowns.SfDropDownBase<TItem>.MainData
Syncfusion.Blazor.DropDowns.SfDropDownBase<TItem>.ListDataSource
Syncfusion.Blazor.DropDowns.SfDropDownBase<TItem>.DataId
Syncfusion.Blazor.DropDowns.SfDropDownBase<TItem>.ItemData
Syncfusion.Blazor.DropDowns.SfDropDownBase<TItem>.IsActionFailed
Syncfusion.Blazor.DropDowns.SfDropDownBase<TItem>.TotalCount
Syncfusion.Blazor.DropDowns.SfDropDownBase<TItem>.ComponentName
Namespace: Syncfusion.Blazor.DropDowns
Assembly: Syncfusion.Blazor.dll
Syntax
public class SfComboBox<TValue, TItem> : SfDropDownList<TValue, TItem>, IInputBase, IDropDowns, IVirtualList<TItem>
Type Parameters
Name Description
TValue

The type of value that will be selected or entered in the ComboBox.
TItem

The type of items that will be displayed in the ComboBox dropdown list.

Constructors

SfComboBox()

Declaration
public SfComboBox()

Properties

AllowCustom

Gets or sets a value indicating whether the ComboBox allows custom values to be entered.

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

true if custom values are allowed the user to enter a value that does not exist in the data source; otherwise, false. The default value is true.

Autofill

Gets or sets a value indicating whether the ComboBox automatically fills the input with the first matched item while typing.

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

true if autofill is enabled; otherwise, false. The default value is false.

ShowClearButton

Gets or sets a value indicating whether the ComboBox should display a clear button to clear the selected value.

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

true if the clear button is visible; otherwise, false. The default value is true.
Overrides
Syncfusion.Blazor.DropDowns.SfDropDownList<TValue, TItem>.ShowClearButton
Remarks

When you click the clear button, the Value, and Index properties are reset to null. This allows users to easily clear the selected value and start fresh.

ValidateOnInput

Gets or sets a value indicating whether the ComboBox should perform validation when input is entered.

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

true if input validation is enabled; otherwise, false. The default value is false.
Remarks

This property is used to validate the form on typing into the input and updating the model value. The ValueChange event will be fired after the component loses its focus.

Methods

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)

Implements

Syncfusion.Blazor.DropDowns.IVirtualList<T>