Class IgbCombo<T>

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
System.Object
BaseRendererControl
IgbCombo<T>
Implements
System.IDisposable
Inherited Members
Namespace: IgniteUI.Blazor.Controls
Assembly: IgniteUI.Blazor.dll
Syntax
public class IgbCombo<T> : BaseRendererControl, RefSink, JsonSerializable, IDisposable
Type Parameters
Name Description
T

Constructors

IgbCombo()

Declaration
public IgbCombo()

Properties

Autofocus

The autofocus attribute of the control.

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

AutofocusList

Focuses the list of options when the menu opens.

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

Blur

Declaration
public EventCallback<IgbVoidEventArgs> Blur { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbVoidEventArgs>

BlurScript

Declaration
public string BlurScript { get; set; }
Property Value
Type Description
System.String

CaseSensitiveIcon

Enables the case sensitive search icon in the filtering input.

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

Change

Declaration
public EventCallback<IgbComboChangeEventArgs> Change { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbComboChangeEventArgs>

ChangeScript

Declaration
public string ChangeScript { get; set; }
Property Value
Type Description
System.String

Closed

Declaration
public EventCallback<IgbVoidEventArgs> Closed { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbVoidEventArgs>

ClosedScript

Declaration
public string ClosedScript { get; set; }
Property Value
Type Description
System.String

Closing

Declaration
public EventCallback<IgbVoidEventArgs> Closing { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbVoidEventArgs>

ClosingScript

Declaration
public string ClosingScript { get; set; }
Property Value
Type Description
System.String

Data

The data source used to generate the list of options.

Declaration
public object Data { get; set; }
Property Value
Type Description
System.Object

DataScript

Provides a means of setting Data in the JavaScript environment.

Declaration
public string DataScript { get; set; }
Property Value
Type Description
System.String

DefaultEventBehavior

Declaration
protected override ControlEventBehavior DefaultEventBehavior { get; }
Property Value
Type Description
ControlEventBehavior
Overrides

DisableClear

Hides the clear button. @default false

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

Disabled

The disabled state of the component

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

DisableFiltering

Disables the filtering of the list of options. @default false

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

DisplayKey

The key in the data source used to display items in the list.

Declaration
public string DisplayKey { get; set; }
Property Value
Type Description
System.String

FilteringOptions

Declaration
public IgbFilteringOptions FilteringOptions { get; set; }
Property Value
Type Description
IgbFilteringOptions

Focus

Declaration
public EventCallback<IgbVoidEventArgs> Focus { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbVoidEventArgs>

FocusScript

Declaration
public string FocusScript { get; set; }
Property Value
Type Description
System.String

GroupHeaderTemplate

Declaration
public RenderFragment<object> GroupHeaderTemplate { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.RenderFragment<System.Object>

GroupHeaderTemplateScript

Provides a means of setting GroupHeaderTemplate in the JavaScript environment.

Declaration
public string GroupHeaderTemplateScript { get; set; }
Property Value
Type Description
System.String

GroupKey

The key in the data source used to group items in the list.

Declaration
public string GroupKey { get; set; }
Property Value
Type Description
System.String

GroupSorting

Sorts the items in each group by ascending or descending order. @default asc @type {"asc" | "desc" | "none"}

Declaration
public GroupingDirection GroupSorting { get; set; }
Property Value
Type Description
GroupingDirection

Invalid

Control the validity of the control.

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

ItemTemplate

Declaration
public RenderFragment<object> ItemTemplate { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.RenderFragment<System.Object>

ItemTemplateScript

Provides a means of setting ItemTemplate in the JavaScript environment.

Declaration
public string ItemTemplateScript { get; set; }
Property Value
Type Description
System.String

Label

The label attribute of the control.

Declaration
public string Label { get; set; }
Property Value
Type Description
System.String

Open

Sets the open state of the component.

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

Opened

Declaration
public EventCallback<IgbVoidEventArgs> Opened { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbVoidEventArgs>

OpenedScript

Declaration
public string OpenedScript { get; set; }
Property Value
Type Description
System.String

Opening

Declaration
public EventCallback<IgbVoidEventArgs> Opening { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbVoidEventArgs>

OpeningScript

Declaration
public string OpeningScript { get; set; }
Property Value
Type Description
System.String

Outlined

The outlined attribute of the control.

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

Placeholder

The placeholder attribute of the control.

Declaration
public string Placeholder { get; set; }
Property Value
Type Description
System.String

PlaceholderSearch

The placeholder attribute of the search input.

Declaration
public string PlaceholderSearch { get; set; }
Property Value
Type Description
System.String

Required

Makes the control a required field in a form context.

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

SingleSelect

Enables single selection mode and moves item filtering to the main input. @default false

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

SupportsVisualChildren

Declaration
protected override bool SupportsVisualChildren { get; }
Property Value
Type Description
System.Boolean
Overrides

Type

Declaration
public override string Type { get; }
Property Value
Type Description
System.String
Overrides

Value

Declaration
public T[] Value { get; set; }
Property Value
Type Description
T[]

ValueChanged

Declaration
public EventCallback<T[]> ValueChanged { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<T[]>

ValueKey

The key in the data source used when selecting items.

Declaration
public string ValueKey { get; set; }
Property Value
Type Description
System.String

Methods

BlurComponent()

Declaration
[WCWidgetMemberName("Blur")]
public void BlurComponent()

BlurComponentAsync()

Removes focus from the component.

Declaration
[WCWidgetMemberName("Blur")]
public Task BlurComponentAsync()
Returns
Type Description
System.Threading.Tasks.Task

CheckValidity()

Declaration
public void CheckValidity()

CheckValidityAsync()

Checks for validity of the control and emits the invalid event if it invalid.

Declaration
public Task CheckValidityAsync()
Returns
Type Description
System.Threading.Tasks.Task

Deselect(Object[])

Declaration
public void Deselect(object[] items)
Parameters
Type Name Description
System.Object[] items

DeselectAsync(Object[])

Declaration
public Task DeselectAsync(object[] items)
Parameters
Type Name Description
System.Object[] items
Returns
Type Description
System.Threading.Tasks.Task

EnsureModulesLoaded()

Declaration
protected override void EnsureModulesLoaded()
Overrides

FindByName(String)

Declaration
public override object FindByName(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
System.Object
Overrides

FocusComponent(IgbFocusOptions)

Declaration
[WCWidgetMemberName("Focus")]
public void FocusComponent(IgbFocusOptions options)
Parameters
Type Name Description
IgbFocusOptions options

FocusComponentAsync(IgbFocusOptions)

Sets focus on the component.

Declaration
[WCWidgetMemberName("Focus")]
public Task FocusComponentAsync(IgbFocusOptions options)
Parameters
Type Name Description
IgbFocusOptions options
Returns
Type Description
System.Threading.Tasks.Task

GetCurrentValue()

Declaration
public T[] GetCurrentValue()
Returns
Type Description
T[]

GetCurrentValueAsync()

Declaration
public Task<T[]> GetCurrentValueAsync()
Returns
Type Description
System.Threading.Tasks.Task<T[]>

GetSelection()

Declaration
public object[] GetSelection()
Returns
Type Description
System.Object[]

GetSelectionAsync()

Declaration
public Task<object[]> GetSelectionAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Object[]>

Hide()

Declaration
public bool Hide()
Returns
Type Description
System.Boolean

HideAsync()

Hides the list of options.

Declaration
public Task<bool> HideAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

ReportValidity()

Declaration
public void ReportValidity()

ReportValidityAsync()

Checks for validity of the control and shows the browser message if it invalid.

Declaration
public Task ReportValidityAsync()
Returns
Type Description
System.Threading.Tasks.Task

ResolveDisplay()

Declaration
protected override string ResolveDisplay()
Returns
Type Description
System.String
Overrides

Select(Object[])

Declaration
public void Select(object[] items)
Parameters
Type Name Description
System.Object[] items

SelectAsync(Object[])

Declaration
public Task SelectAsync(object[] items)
Parameters
Type Name Description
System.Object[] items
Returns
Type Description
System.Threading.Tasks.Task

SetCustomValidity(String)

Declaration
public void SetCustomValidity(string message)
Parameters
Type Name Description
System.String message

SetCustomValidityAsync(String)

Sets a custom validation message for the control. As long as message is not empty, the control is considered invalid.

Declaration
public Task SetCustomValidityAsync(string message)
Parameters
Type Name Description
System.String message
Returns
Type Description
System.Threading.Tasks.Task

SetNativeElement(Object)

Declaration
public void SetNativeElement(object element)
Parameters
Type Name Description
System.Object element

SetNativeElementAsync(Object)

Declaration
public Task SetNativeElementAsync(object element)
Parameters
Type Name Description
System.Object element
Returns
Type Description
System.Threading.Tasks.Task

Show()

Declaration
public bool Show()
Returns
Type Description
System.Boolean

ShowAsync()

Shows the list of options.

Declaration
public Task<bool> ShowAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

Toggle()

Declaration
public bool Toggle()
Returns
Type Description
System.Boolean

ToggleAsync()

Toggles the list of options.

Declaration
public Task<bool> ToggleAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

Implements

System.IDisposable