Class RadzenDropDownDataGrid<TValue>

RadzenDropDownDataGrid component.

Inheritance

System.Object

RadzenComponent

DataBoundFormComponent<TValue>

DropDownBase<TValue>

RadzenDropDownDataGrid<TValue>

Implements

IDisposable

IRadzenFormComponent

Inherited Members

DropDownBase<TValue>.VirtualizationOverscanCount

DropDownBase<TValue>.Virtualize

DropDownBase<TValue>.Count

DropDownBase<TValue>.AllowVirtualization

DropDownBase<TValue>.PageSize

DropDownBase<TValue>.HasValue

DropDownBase<TValue>.HeaderTemplate

DropDownBase<TValue>.FilterAsYouType

DropDownBase<TValue>.AllowClear

DropDownBase<TValue>.Multiple

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>.selectedItems

DropDownBase<TValue>.selectedItem

DropDownBase<TValue>.SelectAll()

DropDownBase<TValue>.ClearAll()

DropDownBase<TValue>.Data

DropDownBase<TValue>.OnParametersSet()

DropDownBase<TValue>.GetItemOrValueFromProperty(Object, String)

DropDownBase<TValue>.PopupID

DropDownBase<TValue>.SearchID

DropDownBase<TValue>.OpenPopupScript()

DropDownBase<TValue>.OpenPopupScriptFromParent()

DropDownBase<TValue>.FilterDelay

DropDownBase<TValue>.search

DropDownBase<TValue>.list

DropDownBase<TValue>.selectedIndex

DropDownBase<TValue>.HandleKeyPress(Microsoft.AspNetCore.Components.Web.KeyboardEventArgs, Boolean, Nullable<Boolean>)

DropDownBase<TValue>.OnFilterKeyPress(Microsoft.AspNetCore.Components.Web.KeyboardEventArgs)

DropDownBase<TValue>.OnKeyPress(Microsoft.AspNetCore.Components.Web.KeyboardEventArgs, Nullable<Boolean>)

DropDownBase<TValue>.OnSelectItem(Object, Boolean)

DropDownBase<TValue>.OnInitialized()

DropDownBase<TValue>.OnParametersSetAsync()

DropDownBase<TValue>.OnChange(ChangeEventArgs)

DropDownBase<TValue>.SelectedItem

DropDownBase<TValue>.Separator

DropDownBase<TValue>.SelectItem(Object, Boolean)

DropDownBase<TValue>.GetValue()

DropDownBase<TValue>.ItemComparer

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>._view

DataBoundFormComponent<TValue>.EditContext

DataBoundFormComponent<TValue>.FieldIdentifier

DataBoundFormComponent<TValue>.ValueExpression

DataBoundFormComponent<TValue>.GetClassList(String)

DataBoundFormComponent<TValue>.FocusAsync()

DataBoundFormComponent<TValue>.FormFieldContext

DataBoundFormComponent<TValue>.CurrentPlaceholder

DataBoundFormComponent<TValue>.OnContextMenu(MouseEventArgs)

RadzenComponent.Attributes

RadzenComponent.Element

RadzenComponent.MouseEnter

RadzenComponent.MouseLeave

RadzenComponent.ContextMenu

RadzenComponent.Culture

RadzenComponent.DefaultCulture

RadzenComponent.OnMouseEnter()

RadzenComponent.OnMouseLeave()

RadzenComponent.OnContextMenu(Microsoft.AspNetCore.Components.Web.MouseEventArgs)

RadzenComponent.Style

RadzenComponent.Visible

RadzenComponent.GetCssClass()

RadzenComponent.GetId()

RadzenComponent.Debounce(Func<Task>, Int32)

RadzenComponent.UniqueID

RadzenComponent.JSRuntime

RadzenComponent.IsJSRuntimeAvailable

RadzenComponent.Reference

RadzenComponent.RaiseContextMenu(Microsoft.AspNetCore.Components.Web.MouseEventArgs)

RadzenComponent.RaiseMouseEnter()

RadzenComponent.RaiseMouseLeave()

RadzenComponent.CurrentStyle

Namespace: Radzen.Blazor

Assembly: Radzen.Blazor.dll

Syntax

public class RadzenDropDownDataGrid<TValue> : DropDownBase<TValue>, IDisposable, IRadzenFormComponent

Type Parameters

Name	Description
TValue	The type of the t value.

Examples

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

Fields

popup

Gets popup element reference.

Declaration

protected ElementReference popup

Field Value

Type	Description
ElementReference

Properties

Add

Gets or sets the action to be executed when the Add button is clicked.

Declaration

public EventCallback<MouseEventArgs> Add { get; set; }

Property Value

Type	Description
EventCallback<MouseEventArgs>

AddAriaLabel

Gets or sets the add button aria-label attribute.

Declaration

public string AddAriaLabel { get; set; }

Property Value

Type	Description
System.String

AllowColumnResize

Gets or sets a value indicating whether column resizing is allowed.

Declaration

public bool AllowColumnResize { get; set; }

Property Value

Type	Description
System.Boolean	true if column resizing is allowed; otherwise, false.

AllowFiltering

Gets or sets a value indicating whether filtering is allowed.

Declaration

public override bool AllowFiltering { get; set; }

Property Value

Type	Description
System.Boolean	true if filtering is allowed; otherwise, false.

Overrides

Radzen.DropDownBase<TValue>.AllowFiltering

AllowFilteringByAllStringColumns

Gets or sets a value indicating whether filtering by all string columns is allowed.

Declaration

public bool AllowFilteringByAllStringColumns { get; set; }

Property Value

Type	Description
System.Boolean	true if filtering by all string columns is allowed; otherwise, false.

AllowFilteringByWord

Gets or sets a value indicating whether filtering by each entered word in the search term, sperated by a space, is allowed.

Declaration

public bool AllowFilteringByWord { get; set; }

Property Value

Type	Description
System.Boolean	true if filtering by individual words is allowed; otherwise, false.

AllowRowSelectOnRowClick

Gets or sets a value indicating whether DataGrid row can be selected on row click.

Declaration

public bool AllowRowSelectOnRowClick { get; set; }

Property Value

Type	Description
System.Boolean	true if DataGrid row can be selected on row click; otherwise, false.

AllowSorting

Gets or sets a value indicating whether sorting is allowed.

Declaration

public bool AllowSorting { get; set; }

Property Value

Type	Description
System.Boolean	true if sorting is allowed; otherwise, false.

CellRender

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

Declaration

public Action<DataGridCellRenderEventArgs<object>> CellRender { get; set; }

Property Value

Type	Description
Action<DataGridCellRenderEventArgs<System.Object>>	The cell render callback.

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

public bool Chips { get; set; }

Property Value

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

Columns

Gets or sets the columns.

Declaration

public RenderFragment Columns { get; set; }

Property Value

Type	Description
RenderFragment	The columns.

ColumnWidth

Gets or sets the width of all columns.

Declaration

public string ColumnWidth { get; set; }

Property Value

Type	Description
System.String	The width of all columns.

DataGrid

Handles the reference to the DataGrid component.

Declaration

public RadzenDataGrid<object> DataGrid { get; }

Property Value

Type	Description
RadzenDataGrid<System.Object>

Density

Gets or sets a value indicating DataGrid density.

Declaration

public Density Density { get; set; }

Property Value

Type	Description
Density

EmptyTemplate

Gets or sets the empty template shown when Data is empty collection.

Declaration

public RenderFragment EmptyTemplate { get; set; }

Property Value

Type	Description
RenderFragment	The empty template.

EmptyText

Gets or sets the empty text.

Declaration

public string EmptyText { get; set; }

Property Value

Type	Description
System.String	The empty text.

FirstPageAriaLabel

Gets or sets the pager's first page button's aria-label attribute.

Declaration

public string FirstPageAriaLabel { get; set; }

Property Value

Type	Description
System.String

FirstPageTitle

Gets or sets the pager's first page button's title attribute.

Declaration

public string FirstPageTitle { get; set; }

Property Value

Type	Description
System.String

FocusFilterOnPopup

Gets or sets whether popup automatically focuses on filter input.

Declaration

public bool FocusFilterOnPopup { get; set; }

Property Value

Type	Description
System.Boolean	true if filter input should auto focus when opened; otherwise, false.

FooterTemplate

Gets or sets the footer template.

Declaration

public RenderFragment FooterTemplate { get; set; }

Property Value

Type	Description
RenderFragment	The footer template.

InputAttributes

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

Declaration

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

Property Value

Type	Description
IReadOnlyDictionary<System.String, System.Object>	The attributes.

IsLoading

Gets or sets a value indicating whether this instance loading indicator is shown.

Declaration

public bool IsLoading { get; set; }

Property Value

Type	Description
System.Boolean	true if this instance loading indicator is shown; otherwise, false.

Items

Gets the items.

Declaration

protected override IEnumerable<object> Items { get; }

Property Value

Type	Description
IEnumerable<System.Object>	The items.

Overrides

Radzen.DropDownBase<TValue>.Items

LastPageAriaLabel

Gets or sets the pager's last page button's aria-label attribute.

Declaration

public string LastPageAriaLabel { get; set; }

Property Value

Type	Description
System.String

LastPageTitle

Gets or sets the pager's last page button's title attribute.

Declaration

public string LastPageTitle { get; set; }

Property Value

Type	Description
System.String

MaxSelectedLabels

Gets or sets the number of maximum selected labels.

Declaration

public int MaxSelectedLabels { get; set; }

Property Value

Type	Description
System.Int32	The maximum selected labels.

NextPageAriaLabel

Gets or sets the pager's next page button's aria-label attribute.

Declaration

public string NextPageAriaLabel { get; set; }

Property Value

Type	Description
System.String

NextPageTitle

Gets or sets the pager's next page button's title attribute.

Declaration

public string NextPageTitle { get; set; }

Property Value

Type	Description
System.String

OpenOnFocus

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

Declaration

public bool OpenOnFocus { get; set; }

Property Value

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

PageAriaLabelFormat

Gets or sets the pager's numeric page number buttons' aria-label attributes.

Declaration

public string PageAriaLabelFormat { get; set; }

Property Value

Type	Description
System.String

PageNumbersCount

Gets or sets the page numbers count.

Declaration

public int PageNumbersCount { get; set; }

Property Value

Type	Description
System.Int32	The page numbers count.

PagerAlwaysVisible

Gets or sets a value indicating whether pager is visible even when not enough data for paging.

Declaration

public bool PagerAlwaysVisible { get; set; }

Property Value

Type	Description
System.Boolean	true if pager is visible even when not enough data for paging otherwise, false.

PagerHorizontalAlign

Gets or sets the horizontal align.

Declaration

public HorizontalAlign PagerHorizontalAlign { get; set; }

Property Value

Type	Description
HorizontalAlign	The horizontal align.

PageTitleFormat

Gets or sets the pager's numeric page number buttons' title attributes.

Declaration

public string PageTitleFormat { get; set; }

Property Value

Type	Description
System.String

PagingSummaryFormat

Gets or sets the pager summary format.

Declaration

public string PagingSummaryFormat { get; set; }

Property Value

Type	Description
System.String	The pager summary format.

PopupStyle

Gets or sets the Popup style.

Declaration

public string PopupStyle { get; set; }

Property Value

Type	Description
System.String	The number Popup style.

PreserveRowSelectionOnPaging

Gets or sets preserving the selected row index on pageing.

Declaration

public bool PreserveRowSelectionOnPaging { get; set; }

Property Value

Type	Description
System.Boolean	Row selection preservation on pageing.

PrevPageAriaLabel

Gets or sets the pager's previous page button's aria-label attribute.

Declaration

public string PrevPageAriaLabel { get; set; }

Property Value

Type	Description
System.String

PrevPageTitle

Gets or sets the pager's previous page button's title attribute.

Declaration

public string PrevPageTitle { get; set; }

Property Value

Type	Description
System.String

Responsive

Gets or sets a value indicating whether this RadzenDropDownDataGrid<TValue> is responsive.

Declaration

public bool Responsive { get; set; }

Property Value

Type	Description
System.Boolean	true if responsive; otherwise, false.

RowRender

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

Declaration

public Action<RowRenderEventArgs<object>> RowRender { get; set; }

Property Value

Type	Description
Action<RowRenderEventArgs<System.Object>>	The row render callback.

SearchTextPlaceholder

Gets or sets the search input placeholder text.

Declaration

public string SearchTextPlaceholder { get; set; }

Property Value

Type	Description
System.String	The search input placeholder text.

SelectedItemsText

Gets or sets the selected items text.

Declaration

public string SelectedItemsText { get; set; }

Property Value

Type	Description
System.String	The selected items text.

SelectedValue

Gets or sets the selected value.

Declaration

public object SelectedValue { get; set; }

Property Value

Type	Description
System.Object	The selected value.

ShowAdd

Gets or sets a value indicating whether the create button is shown.

Declaration

public bool ShowAdd { get; set; }

Property Value

Type	Description
System.Boolean	true if the create button is shown; otherwise, false.

ShowPagingSummary

Gets or sets the pager summary visibility.

Declaration

public bool ShowPagingSummary { get; set; }

Property Value

Type	Description
System.Boolean	The pager summary visibility.

ShowSearch

Gets or sets a value indicating whether search button is shown.

Declaration

public bool ShowSearch { get; set; }

Property Value

Type	Description
System.Boolean	true if search button is shown; otherwise, false.

ValueTemplate

Gets or sets the value template.

Declaration

public RenderFragment<dynamic> ValueTemplate { get; set; }

Property Value

Type	Description
RenderFragment<System.Object>	The value template.

View

Gets the view. The data with sorting, filtering and paging applied.

Declaration

public IEnumerable View { get; }

Property Value

Type	Description
IEnumerable	The view.

Methods

CloseAndFocus()

Closes the dropdown popup and sets focus to the input element.

Declaration

public async Task CloseAndFocus()

Returns

Type	Description
Task	A task that represents the asynchronous operation.

Dispose()

Disposes this instance.

Declaration

public override void Dispose()

Overrides

Radzen.DropDownBase<TValue>.Dispose()

GetComponentCssClass()

Gets the component CSS class.

Declaration

protected override string GetComponentCssClass()

Returns

Type	Description
System.String

Overrides

RadzenComponent.GetComponentCssClass()

HandleKeyPress(KeyboardEventArgs, Boolean, Nullable<Boolean>)

Declaration

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

Parameters

Type	Name	Description
KeyboardEventArgs	args
System.Boolean	isFilter
System.Nullable<System.Boolean>	shouldSelectOnChange

Returns

Type	Description
Task

OnAddClick(MouseEventArgs)

Handles the Click event.

Declaration

public async Task OnAddClick(MouseEventArgs args)

Parameters

Type	Name	Description
MouseEventArgs	args	The instance containing the event data.

Returns

Type	Description
Task

OnAfterRenderAsync(Boolean)

Called when [after render asynchronous].

Declaration

protected override async Task OnAfterRenderAsync(bool firstRender)

Parameters

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

Returns

Type	Description
Task	Task.

Overrides

Radzen.DropDownBase<TValue>.OnAfterRenderAsync(System.Boolean)

OnCellRender(DataGridCellRenderEventArgs<Object>)

Executes CellRender callback.

Declaration

protected virtual void OnCellRender(DataGridCellRenderEventArgs<object> args)

Parameters

Type	Name	Description
DataGridCellRenderEventArgs<System.Object>	args

OnChipRemove(Object)

Event handler for when an item is unselected by clicking a chip

Declaration

protected virtual async Task OnChipRemove(object item)

Parameters

Type	Name	Description
System.Object	item	The item that is to be removed

Returns

Type	Description
Task

OnDataChanged()

Called when data is changed.

Declaration

protected override async Task OnDataChanged()

Returns

Type	Description
Task

Overrides

Radzen.DropDownBase<TValue>.OnDataChanged()

OnFilter(ChangeEventArgs)

Handles the Filter event.

Declaration

protected override async Task OnFilter(ChangeEventArgs args)

Parameters

Type	Name	Description
ChangeEventArgs	args	The instance containing the event data.

Returns

Type	Description
Task

Overrides

Radzen.DropDownBase<TValue>.OnFilter(ChangeEventArgs)

OnRowRender(RowRenderEventArgs<Object>)

Executes RowRender callback.

Declaration

protected virtual void OnRowRender(RowRenderEventArgs<object> args)

Parameters

Type	Name	Description
RowRenderEventArgs<System.Object>	args

OpenPopup(String, Boolean, Boolean)

Opens the popup.

Declaration

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

Parameters

Type	Name	Description
System.String	key	The key.
System.Boolean	isFilter	if set to true [is filter].
System.Boolean	isFromClick	if set to true [is from click].

Returns

Type	Description
System.Threading.Tasks.Task

Overrides

Radzen.DropDownBase<TValue>.OpenPopup(System.String, System.Boolean, System.Boolean)

Reload()

Reloads this instance.

Declaration

public async Task Reload()

Returns

Type	Description
Task

Reset()

Resets component and deselects row

Declaration

public async Task Reset()

Returns

Type	Description
Task

SelectItemFromValue(Object)

Selects the item from value.

Declaration

protected override void SelectItemFromValue(object value)

Parameters

Type	Name	Description
System.Object	value	The value.

Overrides

Radzen.DropDownBase<TValue>.SelectItemFromValue(System.Object)

SetParametersAsync(ParameterView)

Set parameters as an asynchronous operation.

Declaration

public override async Task SetParametersAsync(ParameterView parameters)

Parameters

Type	Name	Description
ParameterView	parameters	The parameters.

Returns

Type	Description
Task	A Task representing the asynchronous operation.

Overrides

Radzen.DropDownBase<TValue>.SetParametersAsync(ParameterView)

Implements

IDisposable

IRadzenFormComponent