The Combo component is similar to the Select component in that it provides a list of options from which the user can make a selection. In contrast to the Select component, the Combo component displays all options in a virtualized list of items, meaning the combo box can simultaneously show thousands of options, where one or more options can be selected. Additionally, users can create custom item templates, allowing for robust data visualization. The Combo component features case-sensitive filtering, grouping, complex data binding, dynamic addition of values and more.
Inheritance
object
ComponentBase
- IComponent
- IHandleEvent
- IHandleAfterRender
- JsonSerializable
- IDisposable
Constructors
Section titled "Constructors"constructor
public IgbCombo()Returns IgbCombo<T>
Properties
Section titled "Properties"DefaultEventBehavior
Section titled "DefaultEventBehavior"Inherited from: IgbBaseComboBox
Gets the components default event behavior.
protected override ControlEventBehavior DefaultEventBehavior { get; }Inherited from: IgbBaseComboBox
Sets the open state of the component.
[Parameter]
public bool Open { get; set; }IgBlazor
Section titled "IgBlazor"Inherited from: BaseRendererControl
[Inject]
protected IIgniteUIBlazor IgBlazor { get; set; }Height
Section titled "Height"Inherited from: BaseRendererControl
[Parameter]
public string Height { get; set; }Width
Section titled "Width"Inherited from: BaseRendererControl
[Parameter]
public string Width { get; set; }Class
Section titled "Class"Inherited from: BaseRendererControl
[Parameter]
public string Class { get; set; }AdditionalAttributes
Section titled "AdditionalAttributes"Inherited from: BaseRendererControl
[Parameter(CaptureUnmatchedValues = true)]
public Dictionary<string, object> AdditionalAttributes { get; set; }ParentTypeName
Section titled "ParentTypeName"Inherited from: BaseRendererControl
protected virtual string ParentTypeName { get; }EventBehavior
Section titled "EventBehavior"Inherited from: BaseRendererControl
Gets or sets how events are bubbled up from JavaScript to Blazor.
[Parameter]
public ControlEventBehavior EventBehavior { get; set; }ChildContent
Section titled "ChildContent"Inherited from: BaseRendererControl
[Parameter]
public RenderFragment ChildContent { get; set; }RoundTripDateConversion
Section titled "RoundTripDateConversion"Inherited from: BaseRendererControl
Gets or sets what type of date conversion to make when round tripping dates.
[Parameter]
public RoundTripDateConversion RoundTripDateConversion { get; set; }UseDirectRender
Section titled "UseDirectRender"Inherited from: BaseRendererControl
protected virtual bool UseDirectRender { get; }DirectRenderElementName
Section titled "DirectRenderElementName"Inherited from: BaseRendererControl
protected virtual string DirectRenderElementName { get; }NeedsDynamicContent
Section titled "NeedsDynamicContent"Inherited from: BaseRendererControl
protected virtual bool NeedsDynamicContent { get; }UseCamelEnumValues
Section titled "UseCamelEnumValues"Inherited from: BaseRendererControl
protected virtual bool UseCamelEnumValues { get; }Autofocus
Section titled "Autofocus"The autofocus attribute of the control.
[Parameter]
public bool Autofocus { get; set; }AutofocusList
Section titled "AutofocusList"Focuses the list of options when the menu opens.
[Parameter]
public bool AutofocusList { get; set; }CaseSensitiveIcon
Section titled "CaseSensitiveIcon"Enables the case sensitive search icon in the filtering input.
[Parameter]
public bool CaseSensitiveIcon { get; set; }The data source used to generate the list of options.
[Parameter]
public object Data { get; set; }DataScript
Section titled "DataScript"Provides a means of setting Data in the JavaScript environment.
[Parameter]
public string DataScript { get; set; }DisableClear
Section titled "DisableClear"Hides the clear button.
[Parameter]
public bool DisableClear { get; set; }DisableFiltering
Section titled "DisableFiltering"Disables the filtering of the list of options.
[Parameter]
public bool DisableFiltering { get; set; }Disabled
Section titled "Disabled"The disabled state of the component
[Parameter]
public bool Disabled { get; set; }DisplayKey
Section titled "DisplayKey"The key in the data source used to display items in the list.
[Parameter]
public string? DisplayKey { get; set; }FilteringOptions
Section titled "FilteringOptions"An object that configures the filtering of the combo.
[Parameter]
public IgbFilteringOptions FilteringOptions { get; set; }GroupHeaderTemplate
Section titled "GroupHeaderTemplate"[Parameter]
public RenderFragment<object> GroupHeaderTemplate { get; set; }GroupHeaderTemplateScript
Section titled "GroupHeaderTemplateScript"Provides a means of setting GroupHeaderTemplate in the JavaScript environment.
[Parameter]
public string GroupHeaderTemplateScript { get; set; }GroupKey
Section titled "GroupKey"The key in the data source used to group items in the list.
[Parameter]
public string GroupKey { get; set; }GroupSorting
Section titled "GroupSorting"Sorts the items in each group by ascending or descending order.
[Parameter]
public GroupingDirection GroupSorting { get; set; }Invalid
Section titled "Invalid"Control the validity of the control.
[Parameter]
public bool Invalid { get; set; }ItemTemplate
Section titled "ItemTemplate"[Parameter]
public RenderFragment<object> ItemTemplate { get; set; }ItemTemplateScript
Section titled "ItemTemplateScript"Provides a means of setting ItemTemplate in the JavaScript environment.
[Parameter]
public string ItemTemplateScript { get; set; }Label
Section titled "Label"The label attribute of the control.
[Parameter]
public string Label { get; set; }Locale
Section titled "Locale"Gets/Sets the locale used for getting language, affecting resource strings.
[Parameter]
public string Locale { get; set; }Outlined
Section titled "Outlined"The outlined attribute of the control.
[Parameter]
public bool Outlined { get; set; }Placeholder
Section titled "Placeholder"The placeholder attribute of the control.
[Parameter]
public string Placeholder { get; set; }PlaceholderSearch
Section titled "PlaceholderSearch"The placeholder attribute of the search input.
[Parameter]
public string PlaceholderSearch { get; set; }Required
Section titled "Required"Makes the control a required field in a form context.
[Parameter]
public bool Required { get; set; }SingleSelect
Section titled "SingleSelect"Enables single selection mode and moves item filtering to the main input.
[Parameter]
public bool SingleSelect { get; set; }SupportsVisualChildren
Section titled "SupportsVisualChildren"protected override bool SupportsVisualChildren { get; }Value
Section titled "Value"Sets the value (selected items). The passed value must be a valid JSON array. If the data source is an array of complex objects, the valueKey attribute must be set. Note that when displayKey is not explicitly set, it will fall back to the value of valueKey.
[Parameter]
public T[] Value { get; set; }ValueKey
Section titled "ValueKey"The key in the data source used when selecting items.
[Parameter]
public string? ValueKey { get; set; }Accessors
Section titled "Accessors"eventCallbacksCache
Section titled "eventCallbacksCache"Inherited from: BaseRendererControl
protected Dictionary<Type, Dictionary<string, FieldInfo>> eventCallbacksCache_cachedSerializedContent
Section titled "_cachedSerializedContent"Inherited from: BaseRendererControl
protected string _cachedSerializedContentMethods
Section titled "Methods"SetNativeElementAsync(object)
Section titled "SetNativeElementAsync(object)"Inherited from: IgbBaseComboBox
public Task SetNativeElementAsync(object element)Parameters
- element:
object
Returns any
SetNativeElement(object)
Section titled "SetNativeElement(object)"Inherited from: IgbBaseComboBox
public void SetNativeElement(object element)Parameters
- element:
object
Returns any
ShowAsync()
Section titled "ShowAsync()"Inherited from: IgbBaseComboBox
Shows the component.
public Task<bool> ShowAsync()Returns any
Show()
Section titled "Show()"Inherited from: IgbBaseComboBox
public bool Show()Returns any
HideAsync()
Section titled "HideAsync()"Inherited from: IgbBaseComboBox
Hides the component.
public Task<bool> HideAsync()Returns any
Hide()
Section titled "Hide()"Inherited from: IgbBaseComboBox
public bool Hide()Returns any
ToggleAsync()
Section titled "ToggleAsync()"Inherited from: IgbBaseComboBox
Toggles the open state of the component.
public Task<bool> ToggleAsync()Returns any
Toggle()
Section titled "Toggle()"Inherited from: IgbBaseComboBox
public bool Toggle()Returns any
ResolveEventBehavior()
Section titled "ResolveEventBehavior()"Inherited from: BaseRendererControl
Resolves the components event behavior if Auto is selected.
protected ControlEventBehavior ResolveEventBehavior()Returns any
ToSpinal(string)
Section titled "ToSpinal(string)"Inherited from: BaseRendererControl
protected string ToSpinal(string value)Parameters
- value:
string
Returns any
TransformSimpleKey(string)
Section titled "TransformSimpleKey(string)"Inherited from: BaseRendererControl
protected virtual string TransformSimpleKey(string key)Parameters
- key:
string
Returns any
IsTransformedEnumValue(string)
Section titled "IsTransformedEnumValue(string)"Inherited from: BaseRendererControl
protected virtual bool IsTransformedEnumValue(string key)Parameters
- key:
string
Returns any
TransformPotentialEnumValue(string, object)
Section titled "TransformPotentialEnumValue(string, object)"Inherited from: BaseRendererControl
protected virtual object TransformPotentialEnumValue(string key, object value)Parameters
- key:
string - value:
object
Returns any
BuildSequenceInfo(int)
Section titled "BuildSequenceInfo(int)"Inherited from: BaseRendererControl
protected virtual SequenceInfo BuildSequenceInfo(int startSequence)Parameters
- startSequence:
int
Returns any
BuildRenderTree(RenderTreeBuilder)
Section titled "BuildRenderTree(RenderTreeBuilder)"Inherited from: BaseRendererControl
protected override void BuildRenderTree(RenderTreeBuilder builder)Parameters
- builder:
RenderTreeBuilder
Returns any
TemplateContentType(string)
Section titled "TemplateContentType(string)"Inherited from: BaseRendererControl
protected Type TemplateContentType(string templateId)Parameters
- templateId:
string
Returns any
OnAfterRenderAsync(bool)
Section titled "OnAfterRenderAsync(bool)"Inherited from: BaseRendererControl
protected override Task OnAfterRenderAsync(bool firstRender)Parameters
- firstRender:
bool
Returns any
EnsureReady()
Section titled "EnsureReady()"Inherited from: BaseRendererControl
public Task EnsureReady()Returns any
MarkPropDirty(string)
Section titled "MarkPropDirty(string)"Inherited from: BaseRendererControl
protected void MarkPropDirty(string propertyName)Parameters
- propertyName:
string
Returns any
IsPropDirty(string)
Section titled "IsPropDirty(string)"Inherited from: BaseRendererControl
protected bool IsPropDirty(string propertyName)Parameters
- propertyName:
string
Returns any
Serialize(SerializationContext, string)
Section titled "Serialize(SerializationContext, string)"Inherited from: BaseRendererControl
public void Serialize(SerializationContext context, string propertyName = null)Parameters
- context:
SerializationContext - propertyName:
string
Returns any
Serialize()
Section titled "Serialize()"Inherited from: BaseRendererControl
public string Serialize()Returns any
InvokeMethod(string, object[], string[], ElementReference[])
Section titled "InvokeMethod(string, object[], string[], ElementReference[])"Inherited from: BaseRendererControl
protected Task<object> InvokeMethod(string methodName, object[] arguments, string[] types, ElementReference[] nativeElements = null)Parameters
- methodName:
string - arguments:
object[] - types:
string[] - nativeElements:
ElementReference[]
Returns any
InvokeMethodSync(string, object[], string[], ElementReference[])
Section titled "InvokeMethodSync(string, object[], string[], ElementReference[])"Inherited from: BaseRendererControl
protected object InvokeMethodSync(string methodName, object[] arguments, string[] types, ElementReference[] nativeElements = null)Parameters
- methodName:
string - arguments:
object[] - types:
string[] - nativeElements:
ElementReference[]
Returns any
SuspendNotifications(object)
Section titled "SuspendNotifications(object)"Inherited from: BaseRendererControl
Prevents data change notifications from be propagated to the component.
public void SuspendNotifications(object dataSource)Parameters
- dataSource:
object
Returns any
ResumeNotifications(object, bool)
Section titled "ResumeNotifications(object, bool)"Inherited from: BaseRendererControl
Resumes data change notifications.
public void ResumeNotifications(object dataSource, bool notify = true)Parameters
- dataSource:
object - notify:
bool
Returns any
NotifyInsertItem(object, int, object)
Section titled "NotifyInsertItem(object, int, object)"Inherited from: BaseRendererControl
public void NotifyInsertItem(object dataSource, int index, object refItem)Parameters
- dataSource:
object - index:
int - refItem:
object
Returns any
NotifyRemoveItem(object, int, object)
Section titled "NotifyRemoveItem(object, int, object)"Inherited from: BaseRendererControl
public void NotifyRemoveItem(object dataSource, int index, object oldItem)Parameters
- dataSource:
object - index:
int - oldItem:
object
Returns any
NotifyClearItems(object)
Section titled "NotifyClearItems(object)"Inherited from: BaseRendererControl
public void NotifyClearItems(object dataSource)Parameters
- dataSource:
object
Returns any
NotifySetItem(object, int, object, object)
Section titled "NotifySetItem(object, int, object, object)"Inherited from: BaseRendererControl
public void NotifySetItem(object dataSource, int index, object oldItem, object newItem)Parameters
- dataSource:
object - index:
int - oldItem:
object - newItem:
object
Returns any
NotifyUpdateItem(object, int, object, bool)
Section titled "NotifyUpdateItem(object, int, object, bool)"Inherited from: BaseRendererControl
public void NotifyUpdateItem(object dataSource, int index, object refItem, bool syncDataOnly = false)Parameters
- dataSource:
object - index:
int - refItem:
object - syncDataOnly:
bool
Returns any
OnRefChanged(string, object)
Section titled "OnRefChanged(string, object)"Inherited from: BaseRendererControl
public void OnRefChanged(string refName, object refValue)Parameters
- refName:
string - refValue:
object
Returns any
OnInvokeReturn(long, object)
Section titled "OnInvokeReturn(long, object)"Inherited from: BaseRendererControl
public void OnInvokeReturn(long invokeId, object returnValue)Parameters
- invokeId:
long - returnValue:
object
Returns any
Camelize(string)
Section titled "Camelize(string)"Inherited from: BaseRendererControl
protected string Camelize(string value)Parameters
- value:
string
Returns any
ToPascal(string)
Section titled "ToPascal(string)"Inherited from: BaseRendererControl
protected string ToPascal(string value)Parameters
- value:
string
Returns any
OnElementNameChanged(BaseRendererElement, string, string)
Section titled "OnElementNameChanged(BaseRendererElement, string, string)"Inherited from: BaseRendererControl
protected void OnElementNameChanged(BaseRendererElement element, string oldName, string newName)Parameters
- element:
BaseRendererElement - oldName:
string - newName:
string
Returns any
Dispose(bool)
Section titled "Dispose(bool)"Inherited from: BaseRendererControl
protected virtual void Dispose(bool disposing)Parameters
- disposing:
bool
Returns any
SetResourceStringAsync(string, string, string)
Section titled "SetResourceStringAsync(string, string, string)"Inherited from: BaseRendererControl
public Task<object> SetResourceStringAsync(string grouping, string id, string value)Parameters
- grouping:
string - id:
string - value:
string
Returns any
SetResourceStringAsync(string, string)
Section titled "SetResourceStringAsync(string, string)"Inherited from: BaseRendererControl
public Task<object> SetResourceStringAsync(string grouping, string json)Parameters
- grouping:
string - json:
string
Returns any
SetPropertyValue(object, PropertyInfo, JsonElement)
Section titled "SetPropertyValue(object, PropertyInfo, JsonElement)"Inherited from: BaseRendererControl
protected void SetPropertyValue(object item, PropertyInfo property, JsonElement jsonElement)Parameters
- item:
object - property:
PropertyInfo - jsonElement:
JsonElement
Returns any
SetPropertyValue(object, PropertyInfo, object)
Section titled "SetPropertyValue(object, PropertyInfo, object)"Inherited from: BaseRendererControl
protected void SetPropertyValue(object item, PropertyInfo property, object value)Parameters
- item:
object - property:
PropertyInfo - value:
object
Returns any
Dispose()
Section titled "Dispose()"Inherited from: BaseRendererControl
public void Dispose()Returns any
BlurComponent()
Section titled "BlurComponent()"[WCWidgetMemberName("Blur")]
public void BlurComponent()Returns any
BlurComponentAsync()
Section titled "BlurComponentAsync()"Removes focus from the component.
[WCWidgetMemberName("Blur")]
public Task BlurComponentAsync()Returns any
CheckValidity()
Section titled "CheckValidity()"public bool CheckValidity()Returns any
CheckValidityAsync()
Section titled "CheckValidityAsync()"Checks for validity of the control and emits the invalid event if it invalid.
public Task<bool> CheckValidityAsync()Returns any
Deselect(object[])
Section titled "Deselect(object[])"public void Deselect(object[] items)Parameters
- items:
object[]
Returns any
DeselectAsync(object[])
Section titled "DeselectAsync(object[])"public Task DeselectAsync(object[] items)Parameters
- items:
object[]
Returns any
EnsureModulesLoaded()
Section titled "EnsureModulesLoaded()"protected override void EnsureModulesLoaded()Returns any
FindByName(string)
Section titled "FindByName(string)"public override object FindByName(string name)Parameters
- name:
string
Returns any
FocusComponent(IgbFocusOptions)
Section titled "FocusComponent(IgbFocusOptions)"[WCWidgetMemberName("Focus")]
public void FocusComponent(IgbFocusOptions options)Parameters
- options:
IgbFocusOptions
Returns any
FocusComponentAsync(IgbFocusOptions)
Section titled "FocusComponentAsync(IgbFocusOptions)"Sets focus on the component.
[WCWidgetMemberName("Focus")]
public Task FocusComponentAsync(IgbFocusOptions options)Parameters
- options:
IgbFocusOptions
Returns any
GetCurrentValue()
Section titled "GetCurrentValue()"public T[] GetCurrentValue()Returns any
GetCurrentValueAsync()
Section titled "GetCurrentValueAsync()"public Task<T[]> GetCurrentValueAsync()Returns any
GetSelection()
Section titled "GetSelection()"public object[] GetSelection()Returns any
GetSelectionAsync()
Section titled "GetSelectionAsync()"public Task<object[]> GetSelectionAsync()Returns any
ReportValidity()
Section titled "ReportValidity()"public bool ReportValidity()Returns any
ReportValidityAsync()
Section titled "ReportValidityAsync()"Checks for validity of the control and shows the browser message if it invalid.
public Task<bool> ReportValidityAsync()Returns any
ResolveDisplay()
Section titled "ResolveDisplay()"protected override string ResolveDisplay()Returns any
Select(object[])
Section titled "Select(object[])"public void Select(object[] items)Parameters
- items:
object[]
Returns any
SelectAsync(object[])
Section titled "SelectAsync(object[])"public Task SelectAsync(object[] items)Parameters
- items:
object[]
Returns any
SetCustomValidity(string)
Section titled "SetCustomValidity(string)"public void SetCustomValidity(string message)Parameters
- message:
string
Returns any
SetCustomValidityAsync(string)
Section titled "SetCustomValidityAsync(string)"Sets a custom validation message for the control. As long as message is not empty, the control is considered invalid.
public Task SetCustomValidityAsync(string message)Parameters
- message:
string
Returns any
Events
Section titled "Events"[Parameter]
public EventCallback<IgbVoidEventArgs> Blur { get; set; }Change
Section titled "Change"[Parameter]
public EventCallback<IgbComboChangeEventArgs> Change { get; set; }Closed
Section titled "Closed"[Parameter]
public EventCallback<IgbVoidEventArgs> Closed { get; set; }Closing
Section titled "Closing"[Parameter]
public EventCallback<IgbVoidEventArgs> Closing { get; set; }Focus
Section titled "Focus"[Parameter]
public EventCallback<IgbVoidEventArgs> Focus { get; set; }Opened
Section titled "Opened"[Parameter]
public EventCallback<IgbVoidEventArgs> Opened { get; set; }Opening
Section titled "Opening"[Parameter]
public EventCallback<IgbVoidEventArgs> Opening { get; set; }ValueChanged
Section titled "ValueChanged"[Parameter]
public EventCallback<T[]> ValueChanged { get; set; }BlurScript
Section titled "BlurScript"[Parameter]
public string BlurScript { get; set; }ChangeScript
Section titled "ChangeScript"[Parameter]
public string ChangeScript { get; set; }ClosedScript
Section titled "ClosedScript"[Parameter]
public string ClosedScript { get; set; }ClosingScript
Section titled "ClosingScript"[Parameter]
public string ClosingScript { get; set; }FocusScript
Section titled "FocusScript"[Parameter]
public string FocusScript { get; set; }OpenedScript
Section titled "OpenedScript"[Parameter]
public string OpenedScript { get; set; }OpeningScript
Section titled "OpeningScript"[Parameter]
public string OpeningScript { get; set; }