Class TelerikComboBox<TItem, TValue>

The class for the Telerik ComboBox component.

Inheritance
System.Object
Telerik.Blazor.Components.Common.BaseComponent
DataBoundComponent<TItem>
TelerikSelectBase<TItem, TValue>
TelerikComboBox<TItem, TValue>
Inherited Members
Namespace: Telerik.Blazor.Components
Assembly: Telerik.Blazor.dll

Syntax

public class TelerikComboBox<TItem, TValue> : TelerikSelectBase<TItem, TValue>, IDisposable
Type Parameters
TItem

TValue

Constructors

TelerikComboBox()

Declaration
public TelerikComboBox()

Properties

AllowCustom

Defines whether custom values to be allowed in the ComboBox. By defaut, the ComboBox dismisses values that do not appear in the supplied list of items. When true, ComboBox behaves as TextBox. Meaning that typeof(Value) should be string.

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

ClearButton

Defines whether to render a clear button in the ComboBox. Clear Button is displayed on hover when the ComboBox has value.

Declaration
public bool ClearButton { get; set; }
Property Value
System.Boolean

FilterOperator

Defines the filter operator. Default value is StringFilterOperator.StartsWidth.

Declaration
public StringFilterOperator FilterOperator { get; set; }
Property Value
StringFilterOperator

OnRead

Fires when the data source is read. Use this to attach your own filtering logic. Once attached, you must implement all such data source operations here, the Component will no longer perform them for you.

Declaration
public EventCallback<ComboBoxReadEventArgs> OnRead { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<ComboBoxReadEventArgs>

Placeholder

The hint that is shown if no item is selected.

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

TextField

Defines the TextField of the Data. Default value: "Text".

Declaration
public override string TextField { get; set; }
Property Value
System.String

Overrides
Telerik.Blazor.Components.Common.TelerikSelectBase<TItem, TValue>.TextField

ValueMapper

A callback function that returns an item that corresponds to the argument value. Used in VirtualScrollingn combined with OnRead to facilitate pre-selection of items that are not currently loaded.

Declaration
public Func<TValue, Task<TItem>> ValueMapper { get; set; }
Property Value
System.Func<TValue, System.Threading.Tasks.Task<TItem>>

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration
protected override void BuildRenderTree(RenderTreeBuilder __builder)
Parameters
Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder __builder

OnAfterRenderAsync(Boolean)

Declaration
protected override Task OnAfterRenderAsync(bool firstRender)
Parameters
System.Boolean firstRender

Returns
System.Threading.Tasks.Task

Overrides
Telerik.Blazor.Components.Common.BaseComponent.OnAfterRenderAsync(System.Boolean)

OnParametersSetAsync()

Declaration
protected override Task OnParametersSetAsync()
Returns
System.Threading.Tasks.Task

Overrides
Telerik.Blazor.Components.Common.TelerikSelectBase<TItem, TValue>.OnParametersSetAsync()

SelectItemAndClose(ListDataItem)

Declaration
protected void SelectItemAndClose(ListDataItem item)
Parameters
Telerik.Blazor.Components.Common.Dropdowns.ListDataItem item