RadzenDataGrid<TItem> Class

RadzenDataGrid<TItem>linkLink to this section

A powerful data grid component for displaying and manipulating tabular data with support for sorting, filtering, paging, grouping, editing, and selection. RadzenDataGrid provides a full-featured table with inline editing, master-detail views, virtualization, export capabilities, and extensive customization options. Supports single/multiple column sorting, simple/advanced filtering, grouping with aggregation, inline/cell editing with validation, and single/multiple row selection with checkbox columns. Features on-demand data loading via LoadData event for server-side operations, export to Excel and CSV formats, column/row templates, group headers/footers, and density modes (Default/Compact) for responsive layouts. The grid can work with in-memory collections or load data on-demand from APIs. Columns are defined using RadzenDataGridColumn components within the Columns template.

Declaration

public RadzenDataGrid<TItem>()

AllColumnsTextlinkLink to this section

Gets or sets the column picker all columns text.

Declaration

public string AllColumnsText { get; set; }

Property Value

AllGroupsExpandedlinkLink to this section

Gets or sets a value indicating whether all groups should be expanded when DataGrid is grouped.

Declaration

public bool? AllGroupsExpanded { get; set; }

Property Value

AllGroupsExpandedChangedlinkLink to this section

Gets or sets the AllGroupsExpanded changed callback.

Declaration

public EventCallback<bool?> AllGroupsExpandedChanged { get; set; }

Property Value

AllowAlternatingRowslinkLink to this section

Gets or sets a value indicating whether DataGrid should use alternating row styles.

Declaration

public bool AllowAlternatingRows { get; set; }

Property Value

AllowColumnPickinglinkLink to this section

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

Declaration

public bool AllowColumnPicking { get; set; }

Property Value

AllowColumnReorderlinkLink to this section

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

Declaration

public bool AllowColumnReorder { get; set; }

Property Value

AllowColumnResizelinkLink to this section

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

Declaration

public bool AllowColumnResize { get; set; }

Property Value

AllowCompositeDataCellslinkLink to this section

Gets or sets a value indicating whether DataGrid data cells will follow the header cells structure in composite columns.

Declaration

public bool AllowCompositeDataCells { get; set; }

Property Value

AllowFilterDateInputlinkLink to this section

Gets or sets a value indicating whether input is allowed in filter DatePicker.

Declaration

public bool AllowFilterDateInput { get; set; }

Property Value

AllowFilteringlinkLink to this section

Gets or sets a value indicating whether filtering is allowed.

Declaration

public bool AllowFiltering { get; set; }

Property Value

AllowGroupinglinkLink to this section

Gets or sets a value indicating whether grouping is allowed.

Declaration

public bool AllowGrouping { get; set; }

Property Value

AllowMultiColumnSortinglinkLink to this section

Gets or sets a value indicating whether multi column sorting is allowed.

Declaration

public bool AllowMultiColumnSorting { get; set; }

Property Value

AllowPickAllColumnslinkLink to this section

Gets or sets a value indicating whether user can pick all columns in column picker.

Declaration

public bool AllowPickAllColumns { get; set; }

Property Value

AllowRowSelectOnRowClicklinkLink to this section

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

Declaration

public bool AllowRowSelectOnRowClick { get; set; }

Property Value

AllowSortinglinkLink to this section

Gets or sets a value indicating whether sorting is allowed.

Declaration

public bool AllowSorting { get; set; }

Property Value

AllowSortingColumnPickerlinkLink to this section

Gets or sets a value indicating whether sorting in column picker is allowed.

Declaration

public bool AllowSortingColumnPicker { get; set; }

Property Value

AllowVirtualizationlinkLink to this section

Gets or sets whether the DataGrid uses virtualization to improve performance with large datasets. When enabled, only visible rows are rendered in the DOM, with additional rows loaded as the user scrolls. Virtualization significantly reduces memory usage and initial render time for grids with thousands of rows.

Declaration

public bool AllowVirtualization { get; set; }

Property Value

AndOperatorTextlinkLink to this section

Gets or sets the and operator text.

Declaration

public string AndOperatorText { get; set; }

Property Value

ApplyFilterTextlinkLink to this section

Gets or sets the apply filter text.

Declaration

public string ApplyFilterText { get; set; }

Property Value

AutoApplyCheckBoxListFilterlinkLink to this section

Gets or sets whether CheckBoxList column filters are applied immediately as options are selected, instead of requiring the filter popup's Apply button. Default is false.

Declaration

public bool AutoApplyCheckBoxListFilter { get; set; }

Property Value

CellClicklinkLink to this section

Gets or sets the cell click callback.

Declaration

public EventCallback<DataGridCellMouseEventArgs<TItem>> CellClick { get; set; }

Property Value

CellContextMenulinkLink to this section

Gets or sets the row click callback.

Declaration

public EventCallback<DataGridCellMouseEventArgs<TItem>> CellContextMenu { get; set; }

Property Value

CellDoubleClicklinkLink to this section

Gets or sets the cell double click callback.

Declaration

public EventCallback<DataGridCellMouseEventArgs<TItem>> CellDoubleClick { get; set; }

Property Value

CellRenderlinkLink to this section

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

Declaration

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

Property Value

ClearFilterTextlinkLink to this section

Gets or sets the clear filter text.

Declaration

public string ClearFilterText { get; set; }

Property Value

CollapseAllTitlelinkLink to this section

Gets or sets the title attribute of the collapse all button.

Declaration

public string CollapseAllTitle { get; set; }

Property Value

ColumnReorderedlinkLink to this section

Gets or sets the column reordered callback.

Declaration

public EventCallback<DataGridColumnReorderedEventArgs<TItem>> ColumnReordered { get; set; }

Property Value

ColumnReorderinglinkLink to this section

Gets or sets the column reordering callback.

Declaration

public EventCallback<DataGridColumnReorderingEventArgs<TItem>> ColumnReordering { get; set; }

Property Value

ColumnResizedlinkLink to this section

Gets or sets the column resized callback.

Declaration

public EventCallback<DataGridColumnResizedEventArgs<TItem>> ColumnResized { get; set; }

Property Value

ColumnWidthlinkLink to this section

Gets or sets the width of all columns.

Declaration

public string ColumnWidth { get; set; }

Property Value

ColumnslinkLink to this section

Gets or sets the columns.

Declaration

public RenderFragment Columns { get; set; }

Property Value

ColumnsCollectionlinkLink to this section

Gets the columns collection.

Declaration

public IList<RadzenDataGridColumn<TItem>> ColumnsCollection { get; }

Property Value

ColumnsPickerAllowFilteringlinkLink to this section

Gets or sets a value indicating whether user can filter columns in column picker.

Declaration

public bool ColumnsPickerAllowFiltering { get; set; }

Property Value

ColumnsPickerMaxSelectedLabelslinkLink to this section

Gets or sets the column picker max selected labels.

Declaration

public int ColumnsPickerMaxSelectedLabels { get; set; }

Property Value

ColumnsShowingTextlinkLink to this section

Gets or sets the column picker columns showing text.

Declaration

public string ColumnsShowingText { get; set; }

Property Value

ColumnsTextlinkLink to this section

Gets or sets the column picker columns text.

Declaration

public string ColumnsText { get; set; }

Property Value

ContainsTextlinkLink to this section

Gets or sets the contains text.

Declaration

public string ContainsText { get; set; }

Property Value

CustomTextlinkLink to this section

Gets or sets the custom filter operator text.

Declaration

public string CustomText { get; set; }

Property Value

DoesNotContainTextlinkLink to this section

Gets or sets the does not contain text.

Declaration

public string DoesNotContainText { get; set; }

Property Value

EditModelinkLink to this section

Gets or sets the edit mode.

Declaration

public DataGridEditMode EditMode { get; set; }

Property Value

EditTemplatelinkLink to this section

Gets or sets the edit template.

Declaration

public RenderFragment<TItem> EditTemplate { get; set; }

Property Value

EmptyTemplatelinkLink to this section

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

Declaration

public RenderFragment EmptyTemplate { get; set; }

Property Value

EmptyTextlinkLink to this section

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

Declaration

public string EmptyText { get; set; }

Property Value

EndsWithTextlinkLink to this section

Gets or sets the ends with text.

Declaration

public string EndsWithText { get; set; }

Property Value

EnumFilterSelectTextlinkLink to this section

Gets or sets the enum filter select text.

Declaration

public string EnumFilterSelectText { get; set; }

Property Value

EnumFilterTranslationFunclinkLink to this section

Allows to define a custom function for enums DisplayAttribute Description property value translation in datagrid Enum filters.

Declaration

public Func<string, string> EnumFilterTranslationFunc { get; set; }

Property Value

EnumNullFilterTextlinkLink to this section

Gets or sets the nullable enum for null value filter text.

Declaration

public string EnumNullFilterText { get; set; }

Property Value

EqualsTextlinkLink to this section

Gets or sets the equals text.

Declaration

public string EqualsText { get; set; }

Property Value

ExpandAllTitlelinkLink to this section

Gets or sets the title attribute of the expand all button.

Declaration

public string ExpandAllTitle { get; set; }

Property Value

ExpandChildItemAriaLabellinkLink to this section

Gets or sets the expand child item aria label text.

Declaration

public string ExpandChildItemAriaLabel { get; set; }

Property Value

ExpandGroupAriaLabellinkLink to this section

Gets or sets the expand group aria label text.

Declaration

public string ExpandGroupAriaLabel { get; set; }

Property Value

ExpandModelinkLink to this section

Gets or sets the expand mode.

Declaration

public DataGridExpandMode ExpandMode { get; set; }

Property Value

FilterlinkLink to this section

Gets or sets the column filter callback.

Declaration

public EventCallback<DataGridColumnFilterEventArgs<TItem>> Filter { get; set; }

Property Value

FilterAsYouTypelinkLink to this section

Gets or sets a value indicating whether filtering is performed as you type. Set to true by default. When set to false, the filter is only applied when the user presses Enter or leaves the filter input.

Declaration

public bool FilterAsYouType { get; set; }

Property Value

FilterCaseSensitivitylinkLink to this section

Gets or sets the filter case sensitivity.

Declaration

public FilterCaseSensitivity FilterCaseSensitivity { get; set; }

Property Value

FilterClearedlinkLink to this section

Gets or sets the column filter cleared callback.

Declaration

public EventCallback<DataGridColumnFilterEventArgs<TItem>> FilterCleared { get; set; }

Property Value

FilterDateFormatlinkLink to this section

Gets or sets the filter date format.

Declaration

public string FilterDateFormat { get; set; }

Property Value

FilterDelaylinkLink to this section

Gets or sets the filter delay.

Declaration

public int FilterDelay { get; set; }

Property Value

FilterIconlinkLink to this section

Gets or set the filter icon to use.

Declaration

public string FilterIcon { get; set; }

Property Value

FilterModelinkLink to this section

Gets or sets the filter mode.

Declaration

public FilterMode FilterMode { get; set; }

Property Value

FilterOperatorAriaLabellinkLink to this section

Gets or sets the column filter value aria label text.

Declaration

public string FilterOperatorAriaLabel { get; set; }

Property Value

FilterPopupRenderModelinkLink to this section

Gets or sets the render mode.

Declaration

public PopupRenderMode FilterPopupRenderMode { get; set; }

Property Value

FilterRowActivelinkLink to this section

Gets whether the filter row (containing filter input controls for each column) is currently visible in the DataGrid. The filter row appears below the header row when filtering is enabled and at least one column is filterable.

Declaration

public bool FilterRowActive { get; }

Property Value

FilterTextlinkLink to this section

Gets or sets the filter text.

Declaration

public string FilterText { get; set; }

Property Value

FilterToggleAriaLabellinkLink to this section

Gets or sets the date simple filter toggle aria label text.

Declaration

public string FilterToggleAriaLabel { get; set; }

Property Value

FilterValueAriaLabellinkLink to this section

Gets or sets the column filter value aria label text.

Declaration

public string FilterValueAriaLabel { get; set; }

Property Value

FooterCellRenderlinkLink to this section

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

Declaration

public Action<DataGridCellRenderEventArgs<TItem>> FooterCellRender { get; set; }

Property Value

FooterTemplatelinkLink to this section

Gives the grid a custom footer, allowing the adding of components to create custom tool bars or custom pagination

Declaration

public RenderFragment FooterTemplate { get; set; }

Property Value

GotoFirstPageOnSortlinkLink to this section

Gets or sets the ability to automatically goto the first page when sorting is changed.

Declaration

public bool GotoFirstPageOnSort { get; set; }

Property Value

GreaterThanOrEqualsTextlinkLink to this section

Gets or sets the greater than or equals text.

Declaration

public string GreaterThanOrEqualsText { get; set; }

Property Value

GreaterThanTextlinkLink to this section

Gets or sets the greater than text.

Declaration

public string GreaterThanText { get; set; }

Property Value

GridLineslinkLink to this section

Gets or sets the grid lines.

Declaration

public DataGridGridLines GridLines { get; set; }

Property Value

GrouplinkLink to this section

Gets or sets the column group callback.

Declaration

public EventCallback<DataGridColumnGroupEventArgs<TItem>> Group { get; set; }

Property Value

GroupFootersAlwaysVisiblelinkLink to this section

Gets or sets a value indicating whether group footers are visible even when the group is collapsed.

Declaration

public bool GroupFootersAlwaysVisible { get; set; }

Property Value

GroupHeaderTemplatelinkLink to this section

Gets or sets the group header template.

Declaration

public RenderFragment<Group> GroupHeaderTemplate { get; set; }

Property Value

GroupHeaderToggleTemplatelinkLink to this section

Gets or sets the group header with option to add custom toggle visibility button template.

Declaration

public RenderFragment<ValueTuple<Group, RadzenDataGridGroupRow<TItem>>> GroupHeaderToggleTemplate { get; set; }

Property Value

GroupPanelTextlinkLink to this section

Gets or sets the group panel text.

Declaration

public string GroupPanelText { get; set; }

Property Value

GroupRowCollapselinkLink to this section

Gets or sets the group row collapse callback.

Declaration

public EventCallback<Group> GroupRowCollapse { get; set; }

Property Value

GroupRowExpandlinkLink to this section

Gets or sets the group row expand callback.

Declaration

public EventCallback<Group> GroupRowExpand { get; set; }

Property Value

GroupRowRenderlinkLink to this section

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

Declaration

public Action<GroupRowRenderEventArgs> GroupRowRender { get; set; }

Property Value

GroupedPagedViewlinkLink to this section

Gets the view grouped and paged.

Declaration

public IEnumerable<GroupResult> GroupedPagedView { get; }

Property Value

GroupslinkLink to this section

Gets or sets the group descriptors.

Declaration

public ObservableCollection<GroupDescriptor> Groups { get; set; }

Property Value

HeaderCellRenderlinkLink to this section

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

Declaration

public Action<DataGridCellRenderEventArgs<TItem>> HeaderCellRender { get; set; }

Property Value

HeaderTemplatelinkLink to this section

Gives the grid a custom header, allowing the adding of components to create custom tool bars in addtion to column grouping and column picker

Declaration

public RenderFragment HeaderTemplate { get; set; }

Property Value

HideGroupedColumnlinkLink to this section

Gets or sets a value indicating whether grouped column should be hidden.

Declaration

public bool HideGroupedColumn { get; set; }

Property Value

InTextlinkLink to this section

Gets or sets the in operator text.

Declaration

public string InText { get; set; }

Property Value

IsEmptyTextlinkLink to this section

Gets or sets the is empty text.

Declaration

public string IsEmptyText { get; set; }

Property Value

IsLoadinglinkLink to this section

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

Declaration

public bool IsLoading { get; set; }

Property Value

IsNotEmptyTextlinkLink to this section

Gets or sets the is not empty text.

Declaration

public string IsNotEmptyText { get; set; }

Property Value

IsNotNullTextlinkLink to this section

Gets or sets the not null text.

Declaration

public string IsNotNullText { get; set; }

Property Value

IsNullTextlinkLink to this section

Gets or sets the is null text.

Declaration

public string IsNullText { get; set; }

Property Value

IsValidlinkLink to this section

Gets whether all inline edit validators in the DataGrid are currently valid. Use this property to check validation state before saving edited rows.

Declaration

public bool IsValid { get; }

Property Value

KeyDownlinkLink to this section

Gets or sets key down callback.

Declaration

public EventCallback<KeyboardEventArgs> KeyDown { get; set; }

Property Value

KeyPropertylinkLink to this section

Gets or sets the key property.

Declaration

public string KeyProperty { get; set; }

Property Value

LessThanOrEqualsTextlinkLink to this section

Gets or sets the less than or equals text.

Declaration

public string LessThanOrEqualsText { get; set; }

Property Value

LessThanTextlinkLink to this section

Gets or sets the less than text.

Declaration

public string LessThanText { get; set; }

Property Value

LoadChildDatalinkLink to this section

Gets or sets the load child data callback.

Declaration

public EventCallback<DataGridLoadChildDataEventArgs<TItem>> LoadChildData { get; set; }

Property Value

LoadColumnFilterDatalinkLink to this section

Gets or sets the callback used to load column filter data for DataGrid FilterMode.CheckBoxList filter mode.

Declaration

public EventCallback<DataGridLoadColumnFilterDataEventArgs<TItem>> LoadColumnFilterData { get; set; }

Property Value

LoadSettingslinkLink to this section

Gets or sets the load settings callback.

Declaration

public Action<DataGridLoadSettingsEventArgs> LoadSettings { get; set; }

Property Value

LogicalFilterOperatorlinkLink to this section

Gets or sets the logical filter operator.

Declaration

public LogicalFilterOperator LogicalFilterOperator { get; set; }

Property Value

LogicalOperatorAriaLabellinkLink to this section

Gets or sets the column logical filter value aria label text.

Declaration

public string LogicalOperatorAriaLabel { get; set; }

Property Value

NotEqualsTextlinkLink to this section

Gets or sets the not equals text.

Declaration

public string NotEqualsText { get; set; }

Property Value

NotInTextlinkLink to this section

Gets or sets the not in operator text.

Declaration

public string NotInText { get; set; }

Property Value

OrOperatorTextlinkLink to this section

Gets or sets the or operator text.

Declaration

public string OrOperatorText { get; set; }

Property Value

PageSizeChangedlinkLink to this section

Gets or sets the page size changed callback.

Declaration

public EventCallback<int> PageSizeChanged { get; set; }

Property Value

PickedColumnsChangedlinkLink to this section

Gets or sets the picked columns changed callback.

Declaration

public EventCallback<DataGridPickedColumnsChangedEventArgs<TItem>> PickedColumnsChanged { get; set; }

Property Value

QuerylinkLink to this section

Gets the query.

Declaration

public Query Query { get; }

Property Value

QueryOnlyVisibleColumnslinkLink to this section

Gets or sets a value indicating whether only visible columns are included in the query.

Declaration

public bool QueryOnlyVisibleColumns { get; set; }

Property Value

RemoveGroupAriaLabellinkLink to this section

Gets or sets the remove group button aria label text.

Declaration

public string RemoveGroupAriaLabel { get; set; }

Property Value

RenderlinkLink to this section

Gets or sets the render callback.

Declaration

public Action<DataGridRenderEventArgs<TItem>> Render { get; set; }

Property Value

RenderAsynclinkLink to this section

Gets or sets the render async callback.

Declaration

public Func<DataGridRenderEventArgs<TItem>, Task> RenderAsync { get; set; }

Property Value

ResponsivelinkLink to this section

Gets or sets a value indicating whether DataGrid is responsive.

Declaration

public bool Responsive { get; set; }

Property Value

RowClicklinkLink to this section

Gets or sets the row click callback.

Declaration

public EventCallback<DataGridRowMouseEventArgs<TItem>> RowClick { get; set; }

Property Value

RowCollapselinkLink to this section

Gets or sets the row collapse callback.

Declaration

public EventCallback<TItem> RowCollapse { get; set; }

Property Value

RowCreatelinkLink to this section

Gets or sets the row create callback.

Declaration

public EventCallback<TItem> RowCreate { get; set; }

Property Value

RowDeselectlinkLink to this section

Gets or sets the row deselect callback.

Declaration

public EventCallback<TItem> RowDeselect { get; set; }

Property Value

RowDoubleClicklinkLink to this section

Gets or sets the row double click callback.

Declaration

public EventCallback<DataGridRowMouseEventArgs<TItem>> RowDoubleClick { get; set; }

Property Value

RowEditlinkLink to this section

Gets or sets the row edit callback.

Declaration

public EventCallback<TItem> RowEdit { get; set; }

Property Value

RowExpandlinkLink to this section

Gets or sets the row expand callback.

Declaration

public EventCallback<TItem> RowExpand { get; set; }

Property Value

RowRenderlinkLink to this section

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

Declaration

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

Property Value

RowSelectlinkLink to this section

Gets or sets the row select callback.

Declaration

public EventCallback<TItem> RowSelect { get; set; }

Property Value

RowUpdatelinkLink to this section

Gets or sets the row update callback.

Declaration

public EventCallback<TItem> RowUpdate { get; set; }

Property Value

SecondFilterOperatorAriaLabellinkLink to this section

Gets or sets the column filter value aria label text.

Declaration

public string SecondFilterOperatorAriaLabel { get; set; }

Property Value

SecondFilterValueAriaLabellinkLink to this section

Gets or sets the column filter value aria label text.

Declaration

public string SecondFilterValueAriaLabel { get; set; }

Property Value

SelectVisibleColumnsAriaLabellinkLink to this section

Gets or sets the select visible columns aria label text.

Declaration

public string SelectVisibleColumnsAriaLabel { get; set; }

Property Value

SelectionModelinkLink to this section

Gets or sets the selection mode.

Declaration

public DataGridSelectionMode SelectionMode { get; set; }

Property Value

SettingslinkLink to this section

Gets or sets DataGrid settings.

Declaration

public DataGridSettings Settings { get; set; }

Property Value

SettingsChangedlinkLink to this section

Gets or sets the settings changed callback.

Declaration

public EventCallback<DataGridSettings> SettingsChanged { get; set; }

Property Value

ShowCellDataAsTooltiplinkLink to this section

Gets or sets a value indicating whether cell data should be shown as tooltip.

Declaration

public bool ShowCellDataAsTooltip { get; set; }

Property Value

ShowColumnTitleAsTooltiplinkLink to this section

Gets or sets a value indicating whether column title should be shown as tooltip.

Declaration

public bool ShowColumnTitleAsTooltip { get; set; }

Property Value

ShowEmptyMessagelinkLink to this section

Gets or sets a value indicating whether DataGrid data body show empty message.

Declaration

public bool ShowEmptyMessage { get; set; }

Property Value

ShowExpandAlllinkLink to this section

Gets or sets a value indicating whether all rows can be expanded at once from the header. Setting is only available when ExpandMode is set to DataGridExpandMode.Multiple.

Declaration

public bool ShowExpandAll { get; set; }

Property Value

ShowExpandColumnlinkLink to this section

Gets or sets whether the expandable indicator column is visible.

Declaration

public bool ShowExpandColumn { get; set; }

Property Value

ShowGroupExpandColumnlinkLink to this section

Gets or sets a value indicating whether to show group visibility column

Declaration

public bool ShowGroupExpandColumn { get; set; }

Property Value

ShowHeaderlinkLink to this section

Gets or sets value if headers are shown.

Declaration

public bool ShowHeader { get; set; }

Property Value

ShowMultiColumnSortingIndexlinkLink to this section

Gets or sets a value indicating whether multi column sorting index is shown.

Declaration

public bool ShowMultiColumnSortingIndex { get; set; }

Property Value

SortlinkLink to this section

Gets or sets the column sort callback.

Declaration

public EventCallback<DataGridColumnSortEventArgs<TItem>> Sort { get; set; }

Property Value

SortslinkLink to this section

Gets or sets the sort descriptors.

Declaration

public ObservableCollection<SortDescriptor> Sorts { get; set; }

Property Value

StartsWithTextlinkLink to this section

Gets or sets the starts with text.

Declaration

public string StartsWithText { get; set; }

Property Value

TabIndexlinkLink to this section

Gets or sets the tabindex applied to the grid element. Set to 0 by default so the grid is a tab stop. Embedding components can set it to -1 to remove the grid from the tab order.

Declaration

public int TabIndex { get; set; }

Property Value

ValuelinkLink to this section

Gets or sets the selected item.

Declaration

public IList<TItem> Value { get; set; }

Property Value

ValueChangedlinkLink to this section

Gets or sets the value changed callback.

Declaration

public EventCallback<IList<TItem>> ValueChanged { get; set; }

Property Value

ViewlinkLink to this section

Gets the view - Data with sorting, filtering and paging applied.

Declaration

public IQueryable<TItem> View { get; }

Property Value

VirtualizationOverscanCountlinkLink to this section

Gets or sets the number of additional rows to render before and after the visible viewport when virtualization is enabled. A higher overscan count reduces the chance of seeing blank space during fast scrolling, but increases the number of rendered elements. The optimal value depends on row height and typical scroll speed.

Declaration

public int VirtualizationOverscanCount { get; set; }

Property Value

VirtualizelinkLink to this section

Gets a reference to the underlying Blazor Virtualize component used for row virtualization. This reference can be used to programmatically control virtualization behavior or access virtualization state. Only available when AllowVirtualization is enabled and items are not grouped.

Declaration

public Virtualization.Virtualize<TItem> Virtualize { get; }

Property Value

AddContextMenulinkLink to this section

Adds context menu for this component.

Declaration

protected override Task AddContextMenu()

Returns

ApplyDateFilterByFilterOperatorlinkLink to this section

Applies the date filter by filter operator.

Declaration

protected void ApplyDateFilterByFilterOperator(RadzenDataGridColumn<TItem> column, FilterOperator filterOperator)

Parameters

ApplyFilterlinkLink to this section

Apply filter to the specified column

Declaration

public Task ApplyFilter(RadzenDataGridColumn<TItem> column, bool closePopup)

Parameters

Returns

BuildRenderTreelinkLink to this section

Declaration

protected override void BuildRenderTree(Rendering.RenderTreeBuilder __builder)

Parameters

CancelEditRowlinkLink to this section

Cancels the edited row.

Declaration

public void CancelEditRow(TItem item)

Parameters

CancelEditRowslinkLink to this section

Cancels the edit of a range of rows.

Declaration

public void CancelEditRows(IEnumerable<TItem> items)

Parameters

ClearFilterlinkLink to this section

?lear filter on the specified column

Declaration

public Task ClearFilter(RadzenDataGridColumn<TItem> column, bool closePopup, bool shouldReload)

Parameters

Returns

CollapseAlllinkLink to this section

Collapse all rows that are expanded

Declaration

public Task CollapseAll()

Returns

CollapseRowslinkLink to this section

Collapse a range of rows.

Declaration

public Task CollapseRows(IEnumerable<TItem> items)

Parameters

Returns

DateFilterOperatorStylelinkLink to this section

The filter operator style for dates.

Declaration

protected string DateFilterOperatorStyle(RadzenDataGridColumn<TItem> column, FilterOperator value)

Parameters

Returns

DisposelinkLink to this section

Declaration

public override void Dispose()

EditRowlinkLink to this section

Edits the row.

Declaration

public Task EditRow(TItem item)

Parameters

Returns

EditRowslinkLink to this section

Edits a range of rows.

Declaration

public Task EditRows(IEnumerable<TItem> items)

Parameters

Returns

ExpandGroupItemlinkLink to this section

Expand group item.

Declaration

public Task ExpandGroupItem(RadzenDataGridGroupRow<TItem> item, bool? expandedOnLoad)

Parameters

Returns

ExpandRowlinkLink to this section

Expands the row to show the content defined in Template property.

Declaration

public Task ExpandRow(TItem item)

Parameters

Returns

ExpandRowslinkLink to this section

Expands a range of rows.

Declaration

public Task ExpandRows(IEnumerable<TItem> items)

Parameters

Returns

GetComponentCssClasslinkLink to this section

Declaration

protected override string GetComponentCssClass()

Returns

InsertAfterRowlinkLink to this section

Inserts new row after specific row item.

Declaration

public Task InsertAfterRow(TItem itemToInsert, TItem rowItem)

Parameters

Returns

InsertRowlinkLink to this section

Inserts new row.

Declaration

public Task InsertRow(TItem item)

Parameters

Returns

IsRowExpandedlinkLink to this section

Gets boolean value indicating if the row is expanded or not.

Declaration

public bool IsRowExpanded(TItem item)

Parameters

Returns

IsRowInEditModelinkLink to this section

Determines whether row in edit mode.

Declaration

public bool IsRowInEditMode(TItem item)

Parameters

Returns

ItemEqualslinkLink to this section

Compares two items for equality. When KeyProperty is set the comparison uses the key value (null-safe — both-null keys are equal, one-null is not), otherwise falls back to Object).

Declaration

protected bool ItemEquals(TItem item, TItem otherItem)

Parameters

Returns

OnAfterRenderAsynclinkLink to this section

Declaration

protected override Task OnAfterRenderAsync(bool firstRender)

Parameters

Returns

OnBecameInvisiblelinkLink to this section

Declaration

protected override void OnBecameInvisible()

OnBlurlinkLink to this section

Handles the blur event.

Declaration

protected virtual Task OnBlur(FocusEventArgs args)

Parameters

Returns

OnCollectionChangedlinkLink to this section

Declaration

protected override void OnCollectionChanged(object sender, Collections.Specialized.NotifyCollectionChangedEventArgs args)

Parameters

OnColumnDropToGrouplinkLink to this section

Called from JS when a touch-initiated column reorder drop lands on the group panel.

Declaration

public Task OnColumnDropToGroup()

Returns

OnColumnReorderEndedlinkLink to this section

Called from JS when a touch-initiated column reorder drop lands on a target column.

Declaration

public Task OnColumnReorderEnded(int columnIndex)

Parameters

Returns

OnColumnResizedlinkLink to this section

Called when column is resized.

Declaration

public Task OnColumnResized(int columnIndex, double value)

Parameters

Returns

OnContextMenulinkLink to this section

Raises ContextMenu.

Declaration

public override Task OnContextMenu(MouseEventArgs args)

Parameters

Returns

OnDataChangedlinkLink to this section

Called when data is changed.

Declaration

protected override void OnDataChanged()

OnFilterlinkLink to this section

Called when filter key pressed.

Declaration

protected virtual Task OnFilter(ChangeEventArgs args, RadzenDataGridColumn<TItem> column, bool force, bool isFirst)

Parameters

Returns

OnFilterKeyPresslinkLink to this section

Called when filter key pressed.

Declaration

protected virtual void OnFilterKeyPress(EventArgs args, RadzenDataGridColumn<TItem> column)

Parameters

OnInitializedlinkLink to this section

Declaration

protected override void OnInitialized()

OnKeyDownlinkLink to this section

Handles the key down event.

Declaration

protected virtual Task OnKeyDown(KeyboardEventArgs args)

Parameters

Returns

OnPageSizeChangedlinkLink to this section

Declaration

protected override Task OnPageSizeChanged(int value)

Parameters

Returns

OnParametersSetAsynclinkLink to this section

Called when parameters set asynchronous.

Declaration

protected override Task OnParametersSetAsync()

Returns

OrderBylinkLink to this section

Orders the DataGrid by property name.

Declaration

public void OrderBy(string property)

Parameters

OrderByDescendinglinkLink to this section

Orders descending the DataGrid by property name.

Declaration

public void OrderByDescending(string property)

Parameters

RefreshDataAsynclinkLink to this section

Clears the internal data cache and refreshes the DataGrid, reloading data from the source. When virtualization is enabled, this method refreshes the Virtualize component. Otherwise, it triggers a standard reload. Call this method after external data changes to ensure the grid displays current data.

Declaration

public Task RefreshDataAsync()

Returns

ReloadlinkLink to this section

Reloads this instance.

Declaration

public override Task Reload()

Returns

ReloadSettingslinkLink to this section

Force load of the DataGrid Settings. This method triggers a reload of the DataGrid settings, optionally forcing a reload even if the settings are already loaded.

Declaration

public Task ReloadSettings(bool forceReload)

Parameters

Returns

ResetlinkLink to this section

Resets the internal LoadData state, forcing the next data operation to reload from the source. This is useful when you've made changes to the underlying data source and want to ensure the next load operation fetches fresh data instead of using cached arguments. Typically called before RefreshDataAsync or when manually managing data reload.

Declaration

public void Reset(bool resetColumnState, bool resetRowState)

Parameters

ResetLoadDatalinkLink to this section

Resets the internal LoadData state, forcing the next data operation to reload from the source. This is useful when you've made changes to the underlying data source and want to ensure the next load operation fetches fresh data instead of using cached arguments. Typically called before RefreshDataAsync or when manually managing data reload.

Declaration

public void ResetLoadData()

SaveSettingslinkLink to this section

Saves DataGrid settings as JSON string.

Declaration

public void SaveSettings()

SelectRowlinkLink to this section

Selects the row.

Declaration

public Task SelectRow(TItem item, bool raiseEvent)

Parameters

Returns

SetColumnFilterValueFromSettingslinkLink to this section

Override this method to customize how filter values are serialized back typed from the settings.

Declaration

public virtual bool SetColumnFilterValueFromSettings(RadzenDataGridColumn<TItem> gridColumn, DataGridColumnSettings columnSettings, bool isFirst)

Parameters

Returns

SetParametersAsynclinkLink to this section

Declaration

public override Task SetParametersAsync(ParameterView parameters)

Parameters

Returns

UpdatePickableColumnslinkLink to this section

Updates pickable columns.

Declaration

public void UpdatePickableColumns()

UpdateRowlinkLink to this section

Updates the row.

Declaration

public Task UpdateRow(TItem item)

Parameters

Returns