Class RadzenDropDown<TValue>

RadzenDropDown component.

Inheritance

object

ComponentBase

RadzenComponent

DataBoundFormComponent<TValue>

DropDownBase<TValue>

RadzenDropDown<TValue>

Implements

IComponent

IHandleEvent

IHandleAfterRender

IDisposable

IRadzenFormComponent

Inherited Members

DropDownBase<TValue>.selectedItems

DropDownBase<TValue>.selectedItem

DropDownBase<TValue>.search

DropDownBase<TValue>.list

DropDownBase<TValue>.selectedIndex

DropDownBase<TValue>.Reset()

DropDownBase<TValue>.ClearAll()

DropDownBase<TValue>.OnParametersSet()

DropDownBase<TValue>.GetItemOrValueFromProperty(object, string)

DropDownBase<TValue>.OnDataChanged()

DropDownBase<TValue>.OpenPopupScript()

DropDownBase<TValue>.OpenPopupScriptFromParent()

DropDownBase<TValue>.OnFilterKeyPress(KeyboardEventArgs)

DropDownBase<TValue>.OnKeyPress(KeyboardEventArgs, bool?)

DropDownBase<TValue>.OnFilter(ChangeEventArgs)

DropDownBase<TValue>.OnInitialized()

DropDownBase<TValue>.OnParametersSetAsync()

DropDownBase<TValue>.OnChange(ChangeEventArgs)

DropDownBase<TValue>.SelectItem(object, bool)

DropDownBase<TValue>.GetValue()

DropDownBase<TValue>.SelectItemFromValue(object)

DropDownBase<TValue>.VirtualizationOverscanCount

DropDownBase<TValue>.Virtualize

DropDownBase<TValue>.Count

DropDownBase<TValue>.AllowVirtualization

DropDownBase<TValue>.PageSize

DropDownBase<TValue>.HasValue

DropDownBase<TValue>.HeaderTemplate

DropDownBase<TValue>.AllowFiltering

DropDownBase<TValue>.FilterAsYouType

DropDownBase<TValue>.AllowClear

DropDownBase<TValue>.Multiple

DropDownBase<TValue>.ResetSelectedIndexOnFilter

DropDownBase<TValue>.AllowSelectAll

DropDownBase<TValue>.Template

DropDownBase<TValue>.ValueProperty

DropDownBase<TValue>.DisabledProperty

DropDownBase<TValue>.RemoveChipTitle

DropDownBase<TValue>.SearchAriaLabel

DropDownBase<TValue>.EmptyAriaLabel

DropDownBase<TValue>.SelectedItemChanged

DropDownBase<TValue>.Data

DropDownBase<TValue>.PopupID

DropDownBase<TValue>.SearchID

DropDownBase<TValue>.FilterDelay

DropDownBase<TValue>.SelectedItem

DropDownBase<TValue>.Separator

DropDownBase<TValue>.Items

DropDownBase<TValue>.View

DropDownBase<TValue>.ItemComparer

DataBoundFormComponent<TValue>._view

DataBoundFormComponent<TValue>.GetClassList(string)

DataBoundFormComponent<TValue>.FocusAsync()

DataBoundFormComponent<TValue>.OnContextMenu(MouseEventArgs)

DataBoundFormComponent<TValue>.TabIndex

DataBoundFormComponent<TValue>.FilterCaseSensitivity

DataBoundFormComponent<TValue>.FilterOperator

DataBoundFormComponent<TValue>.Name

DataBoundFormComponent<TValue>.Placeholder

DataBoundFormComponent<TValue>.Disabled

DataBoundFormComponent<TValue>.Change

DataBoundFormComponent<TValue>.LoadData

DataBoundFormComponent<TValue>.Form

DataBoundFormComponent<TValue>.Value

DataBoundFormComponent<TValue>.ValueChanged

DataBoundFormComponent<TValue>.IsBound

DataBoundFormComponent<TValue>.TextProperty

DataBoundFormComponent<TValue>.Query

DataBoundFormComponent<TValue>.SearchText

DataBoundFormComponent<TValue>.SearchTextChanged

DataBoundFormComponent<TValue>.EditContext

DataBoundFormComponent<TValue>.FieldIdentifier

DataBoundFormComponent<TValue>.ValueExpression

DataBoundFormComponent<TValue>.FormFieldContext

DataBoundFormComponent<TValue>.CurrentPlaceholder

RadzenComponent.OnMouseEnter()

RadzenComponent.OnMouseLeave()

RadzenComponent.GetCssClass()

RadzenComponent.GetId()

RadzenComponent.Debounce(Func<Task>, int)

RadzenComponent.RaiseContextMenu(MouseEventArgs)

RadzenComponent.RaiseMouseEnter()

RadzenComponent.RaiseMouseLeave()

RadzenComponent.Attributes

RadzenComponent.Element

RadzenComponent.MouseEnter

RadzenComponent.MouseLeave

RadzenComponent.ContextMenu

RadzenComponent.Culture

RadzenComponent.DefaultCulture

RadzenComponent.Style

RadzenComponent.Visible

RadzenComponent.UniqueID

RadzenComponent.JSRuntime

RadzenComponent.IsJSRuntimeAvailable

RadzenComponent.Reference

RadzenComponent.CurrentStyle

ComponentBase.OnInitializedAsync()

ComponentBase.StateHasChanged()

ComponentBase.ShouldRender()

ComponentBase.OnAfterRender(bool)

ComponentBase.InvokeAsync(Action)

ComponentBase.InvokeAsync(Func<Task>)

ComponentBase.DispatchExceptionAsync(Exception)

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Radzen.Blazor

Assembly: Radzen.Blazor.dll

Syntax

public class RadzenDropDown<TValue> : DropDownBase<TValue>, IComponent, IHandleEvent, IHandleAfterRender, IDisposable, IRadzenFormComponent

Type Parameters

Name	Description
TValue	The type of the value.

Examples

<RadzenDropDown @bind-Value=@customerID TValue="string" Data=@customers TextProperty="CompanyName" ValueProperty="CustomerID" Change=@(args => Console.WriteLine($"Selected CustomerID: {args}")) />

Constructors

RadzenDropDown()

RadzenDropDown component.

Declaration

public RadzenDropDown()

Examples

<RadzenDropDown @bind-Value=@customerID TValue="string" Data=@customers TextProperty="CompanyName" ValueProperty="CustomerID" Change=@(args => Console.WriteLine($"Selected CustomerID: {args}")) />

Properties

Chips

Gets or sets a value indicating whether the selected items will be displayed as chips. Set to false by default. Requires Multiple to be set to true.

Declaration

[Parameter]
public bool Chips { get; set; }

Property Value

Type	Description
bool	true to display the selected items as chips; otherwise, false.

ClearSearchAfterSelection

Gets or sets a value indicating whether search field need to be cleared after selection. Set to false by default.

Declaration

[Parameter]
public bool ClearSearchAfterSelection { get; set; }

Property Value

Type	Description
bool	true if need to be cleared; otherwise, false.

Close

Callback for when a dropdown is closed.

Declaration

[Parameter]
public EventCallback Close { get; set; }

Property Value

Type	Description
EventCallback

EmptyTemplate

Gets or sets the empty template.

Declaration

[Parameter]
public RenderFragment EmptyTemplate { get; set; }

Property Value

Type	Description
RenderFragment	The empty template.

FilterAutoCompleteType

Gets or Sets the filter autocomplete type.

Declaration

[Parameter]
public AutoCompleteType FilterAutoCompleteType { get; set; }

Property Value

Type	Description
AutoCompleteType	The filter autocomplete type. Default: Off

FilterPlaceholder

Gets or sets the filter placeholder.

Declaration

[Parameter]
public string FilterPlaceholder { get; set; }

Property Value

Type	Description
string	The filter placeholder.

InputAttributes

Specifies additional custom attributes that will be rendered by the input.

Declaration

[Parameter]
public IReadOnlyDictionary<string, object> InputAttributes { get; set; }

Property Value

Type	Description
IReadOnlyDictionary<string, object>	The attributes.

ItemRender

Gets or sets the row render callback. Use it to set row attributes.

Declaration

[Parameter]
public Action<DropDownItemRenderEventArgs<TValue>> ItemRender { get; set; }

Property Value

Type	Description
Action<DropDownItemRenderEventArgs<TValue>>	The row render callback.

MaxSelectedLabels

Gets or sets the number of maximum selected labels.

Declaration

[Parameter]
public int MaxSelectedLabels { get; set; }

Property Value

Type	Description
int	The number of maximum selected labels.

Open

Callback for when a dropdown is opened.

Declaration

[Parameter]
public EventCallback Open { get; set; }

Property Value

Type	Description
EventCallback

OpenOnFocus

Gets or sets a value indicating whether popup should open on focus. Set to false by default.

Declaration

[Parameter]
public bool OpenOnFocus { get; set; }

Property Value

Type	Description
bool	true if popup should open on focus; otherwise, false.

PopupStyle

Gets or sets the Popup height.

Declaration

[Parameter]
public string PopupStyle { get; set; }

Property Value

Type	Description
string	The number Popup height.

ReadOnly

Gets or sets a value indicating whether is read only.

Declaration

[Parameter]
public bool ReadOnly { get; set; }

Property Value

Type	Description
bool	true if is read only; otherwise, false.

SelectAllText

Gets or sets the select all text.

Declaration

[Parameter]
public string SelectAllText { get; set; }

Property Value

Type	Description
string	The select all text.

SelectedItemsText

Gets or sets the selected items text.

Declaration

[Parameter]
public string SelectedItemsText { get; set; }

Property Value

Type	Description
string	The selected items text.

ValueTemplate

Gets or sets the value template.

Declaration

[Parameter]
public RenderFragment<dynamic> ValueTemplate { get; set; }

Property Value

Type	Description
RenderFragment<dynamic>	The value template.

Methods

BuildRenderTree(RenderTreeBuilder)

RadzenDropDown component.

Declaration

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

Type	Name	Description
RenderTreeBuilder	__builder

Overrides

ComponentBase.BuildRenderTree(RenderTreeBuilder)

Dispose()

Disposes this instance.

Declaration

public override void Dispose()

Overrides

DropDownBase<TValue>.Dispose()

GetComponentCssClass()

Gets the component CSS class.

Declaration

protected override string GetComponentCssClass()

Returns

Type	Description
string

Overrides

RadzenComponent.GetComponentCssClass()

HandleKeyPress(KeyboardEventArgs, bool, bool?)

Handles the key press.

Declaration

protected override Task HandleKeyPress(KeyboardEventArgs args, bool isFilter, bool? shouldSelectOnChange = null)

Parameters

Type	Name	Description
KeyboardEventArgs	args	The KeyboardEventArgs instance containing the event data.
bool	isFilter	if set to true [is filter].
bool?	shouldSelectOnChange	Should select item on item change with keyboard.

Returns

Type	Description
Task

Overrides

DropDownBase<TValue>.HandleKeyPress(KeyboardEventArgs, bool, bool?)

OnAfterRenderAsync(bool)

Called when [after render asynchronous].

Declaration

protected override Task OnAfterRenderAsync(bool firstRender)

Parameters

Type	Name	Description
bool	firstRender	if set to true [first render].

Returns

Type	Description
Task	Task.

Overrides

DropDownBase<TValue>.OnAfterRenderAsync(bool)

OnClose()

Called when popup is closed.

Declaration

[JSInvokable]
public Task OnClose()

Returns

Type	Description
Task

OnSelectItem(object, bool)

Called when item is selected.

Declaration

protected override Task OnSelectItem(object item, bool isFromKey = false)

Parameters

Type	Name	Description
object	item	The item.
bool	isFromKey	if set to true [is from key].

Returns

Type	Description
Task

Overrides

DropDownBase<TValue>.OnSelectItem(object, bool)

OpenPopup(string, bool, bool)

Opens the popup.

Declaration

protected override Task OpenPopup(string key = "ArrowDown", bool isFilter = false, bool isFromClick = false)

Parameters

Type	Name	Description
string	key	The key.
bool	isFilter	if set to true [is filter].
bool	isFromClick	if set to true [is from click].

Returns

Type	Description
Task

Overrides

DropDownBase<TValue>.OpenPopup(string, bool, bool)

SelectAll()

Selects all.

Declaration

protected override Task SelectAll()

Returns

Type	Description
Task

Overrides

DropDownBase<TValue>.SelectAll()

SetParametersAsync(ParameterView)

Set parameters as an asynchronous operation.

Declaration

public override Task SetParametersAsync(ParameterView parameters)

Parameters

Type	Name	Description
ParameterView	parameters	The parameters.

Returns

Type	Description
Task	A Task representing the asynchronous operation.

Overrides

DropDownBase<TValue>.SetParametersAsync(ParameterView)

Implements

IComponent

IHandleEvent

IHandleAfterRender

IDisposable

IRadzenFormComponent