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.
IComponent
IHandleEvent
IHandleAfterRender
PagedDataBoundComponent<TItem>.OnPageChanged
PagedDataBoundComponent<TItem>.CalculatePager
PagedDataBoundComponent<TItem>.GoToPage
PagedDataBoundComponent<TItem>.FirstPage
PagedDataBoundComponent<TItem>.PrevPage
PagedDataBoundComponent<TItem>.NextPage
PagedDataBoundComponent<TItem>.LastPage
PagedDataBoundComponent<TItem>.PagerPosition
PagedDataBoundComponent<TItem>.PagerAlwaysVisible
PagedDataBoundComponent<TItem>.PagerHorizontalAlign
PagedDataBoundComponent<TItem>.Density
PagedDataBoundComponent<TItem>.AllowPaging
PagedDataBoundComponent<TItem>.PageSize
PagedDataBoundComponent<TItem>.PageNumbersCount
PagedDataBoundComponent<TItem>.Count
PagedDataBoundComponent<TItem>.CurrentPage
PagedDataBoundComponent<TItem>.Template
PagedDataBoundComponent<TItem>.LoadingTemplate
PagedDataBoundComponent<TItem>.Data
PagedDataBoundComponent<TItem>.PageSizeOptions
PagedDataBoundComponent<TItem>.PageSizeText
PagedDataBoundComponent<TItem>.ShowPagingSummary
PagedDataBoundComponent<TItem>.PagingSummaryFormat
PagedDataBoundComponent<TItem>.PagingSummaryTemplate
PagedDataBoundComponent<TItem>.FirstPageTitle
PagedDataBoundComponent<TItem>.FirstPageAriaLabel
PagedDataBoundComponent<TItem>.PrevPageLabel
PagedDataBoundComponent<TItem>.PrevPageTitle
PagedDataBoundComponent<TItem>.PrevPageAriaLabel
PagedDataBoundComponent<TItem>.LastPageTitle
PagedDataBoundComponent<TItem>.LastPageAriaLabel
PagedDataBoundComponent<TItem>.NextPageLabel
PagedDataBoundComponent<TItem>.NextPageTitle
PagedDataBoundComponent<TItem>.NextPageAriaLabel
PagedDataBoundComponent<TItem>.PageTitleFormat
PagedDataBoundComponent<TItem>.PageAriaLabelFormat
PagedDataBoundComponent<TItem>.PagedView
PagedDataBoundComponent<TItem>.LoadData
PagedDataBoundComponent<TItem>.Page
PagedDataBoundComponent<TItem>.skip
PagedDataBoundComponent<TItem>.topPager
PagedDataBoundComponent<TItem>.bottomPager
RadzenComponent.RaiseContextMenu
RadzenComponent.RaiseMouseEnter
RadzenComponent.RaiseMouseLeave
RadzenComponent.DefaultCulture
RadzenComponent.IsJSRuntimeAvailable
ComponentBase.OnInitializedAsync
ComponentBase.OnParametersSet
ComponentBase.StateHasChanged
ComponentBase.ShouldRender
ComponentBase.OnAfterRender
ComponentBase.InvokeAsync
ComponentBase.DispatchExceptionAsync
ComponentBase.RendererInfo
ComponentBase.Assets
ComponentBase.AssignedRenderMode
Namespace: Radzen.Blazor
Assembly: Radzen.Blazor.dll
public class RadzenDataGrid<TItem> : PagedDataBoundComponent<TItem>, IComponent, IHandleEvent, IHandleAfterRender| Name | Description |
|---|---|
| TItem | The type of data items displayed in the grid. Each row represents one instance of TItem. |
Basic data grid with sorting, paging, and filtering:
<RadzenDataGrid Data=@orders TItem="Order" AllowSorting="true" AllowPaging="true" AllowFiltering="true" PageSize="10">
<Columns>
<RadzenDataGridColumn TItem="Order" Property="OrderId" Title="Order ID" />
<RadzenDataGridColumn TItem="Order" Property="OrderDate" Title="Order Date" FormatString="{0:d}" />
<RadzenDataGridColumn TItem="Order" Property="CustomerName" Title="Customer" />
<RadzenDataGridColumn TItem="Order" Property="Total" Title="Total" FormatString="{0:C}" />
</Columns>
</RadzenDataGrid>
Grid with inline editing:
<RadzenDataGrid @ref=grid Data=@orders TItem="Order" EditMode="DataGridEditMode.Single">
<Columns>
<RadzenDataGridColumn TItem="Order" Property="OrderId" Title="ID" Frozen="true">
<EditTemplate Context="order">
<RadzenNumeric @bind-Value="order.OrderId" Style="width:100%" />
</EditTemplate>
</RadzenDataGridColumn>
<RadzenDataGridColumn TItem="Order" Context="order" Filterable="false" Sortable="false" TextAlign="TextAlign.Right">
<Template Context="order">
<RadzenButton Icon="edit" ButtonStyle="ButtonStyle.Light" Click="@(args => EditRow(order))" />
</Template>
<EditTemplate Context="order">
<RadzenButton Icon="check" ButtonStyle="ButtonStyle.Success" Click="@(args => SaveRow(order))" />
<RadzenButton Icon="close" ButtonStyle="ButtonStyle.Light" Click="@(args => CancelEdit(order))" />
</EditTemplate>
</RadzenDataGridColumn>
</Columns>
</RadzenDataGrid>
Server-side data with LoadData:
<RadzenDataGrid Data=@orders TItem="Order" LoadData=@LoadData Count=@count IsLoading=@isLoading
AllowSorting="true" AllowFiltering="true" AllowPaging="true" PageSize="20">
<Columns>
<RadzenDataGridColumn TItem="Order" Property="OrderId" Title="ID" />
</Columns>
</RadzenDataGrid>
@code {
IEnumerable<Order> orders;
int count;
bool isLoading;
async Task LoadData(LoadDataArgs args)
{
isLoading = true;
var result = await orderService.GetOrders(args.Skip, args.Top, args.OrderBy, args.Filter);
orders = result.Data;
count = result.Count;
isLoading = false;
}
}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.
public RadzenDataGrid<TItem>()Gets or sets the column picker all columns text.
public string AllColumnsText { get; set; }
| Type | Description |
|---|---|
| string | Gets or sets the column picker all columns text. |
Gets or sets a value indicating whether all groups should be expanded when DataGrid is grouped.
public bool? AllGroupsExpanded { get; set; }
| Type | Description |
|---|---|
| bool? | Gets or sets a value indicating whether all groups should be expanded when DataGrid is grouped. |
Gets or sets the AllGroupsExpanded changed callback.
public EventCallback<bool?> AllGroupsExpandedChanged { get; set; }
| Type | Description |
|---|---|
| EventCallback<bool?> | Gets or sets the AllGroupsExpanded changed callback. |
Gets or sets a value indicating whether DataGrid should use alternating row styles.
public bool AllowAlternatingRows { get; set; }
| Type | Description |
|---|---|
| bool | Gets or sets a value indicating whether DataGrid should use alternating row styles. |
Gets or sets a value indicating whether column picking is allowed.
public bool AllowColumnPicking { get; set; }
| Type | Description |
|---|---|
| bool | Gets or sets a value indicating whether column picking is allowed. |
Gets or sets a value indicating whether column reorder is allowed.
public bool AllowColumnReorder { get; set; }
| Type | Description |
|---|---|
| bool | Gets or sets a value indicating whether column reorder is allowed. |
Gets or sets a value indicating whether column resizing is allowed.
public bool AllowColumnResize { get; set; }
| Type | Description |
|---|---|
| bool | Gets or sets a value indicating whether column resizing is allowed. |
Gets or sets a value indicating whether DataGrid data cells will follow the header cells structure in composite columns.
public bool AllowCompositeDataCells { get; set; }
| Type | Description |
|---|---|
| bool | Gets or sets a value indicating whether DataGrid data cells will follow the header cells structure in composite columns. |
Gets or sets a value indicating whether input is allowed in filter DatePicker.
public bool AllowFilterDateInput { get; set; }
| Type | Description |
|---|---|
| bool | Gets or sets a value indicating whether input is allowed in filter DatePicker. |
Gets or sets a value indicating whether filtering is allowed.
public bool AllowFiltering { get; set; }
| Type | Description |
|---|---|
| bool | Gets or sets a value indicating whether filtering is allowed. |
Gets or sets a value indicating whether grouping is allowed.
public bool AllowGrouping { get; set; }
| Type | Description |
|---|---|
| bool | Gets or sets a value indicating whether grouping is allowed. |
Gets or sets a value indicating whether multi column sorting is allowed.
public bool AllowMultiColumnSorting { get; set; }
| Type | Description |
|---|---|
| bool | Gets or sets a value indicating whether multi column sorting is allowed. |
Gets or sets a value indicating whether user can pick all columns in column picker.
public bool AllowPickAllColumns { get; set; }
| Type | Description |
|---|---|
| bool | Gets or sets a value indicating whether user can pick all columns in column picker. |
Gets or sets a value indicating whether DataGrid row can be selected on row click.
public bool AllowRowSelectOnRowClick { get; set; }
| Type | Description |
|---|---|
| bool | Gets or sets a value indicating whether DataGrid row can be selected on row click. |
Gets or sets a value indicating whether sorting is allowed.
public bool AllowSorting { get; set; }
| Type | Description |
|---|---|
| bool | Gets or sets a value indicating whether sorting is allowed. |
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.
public bool AllowVirtualization { get; set; }
| Type | Description |
|---|---|
| bool | 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. |
Gets or sets the and operator text.
public string AndOperatorText { get; set; }
| Type | Description |
|---|---|
| string | Gets or sets the and operator text. |
Gets or sets the apply filter text.
public string ApplyFilterText { get; set; }
| Type | Description |
|---|---|
| string | Gets or sets the apply filter text. |
Gets or sets the cell click callback.
public EventCallback<DataGridCellMouseEventArgs<TItem>> CellClick { get; set; }
| Type | Description |
|---|---|
| EventCallback<DataGridCellMouseEventArgs<TItem>> | Gets or sets the cell click callback. |
Gets or sets the row click callback.
public EventCallback<DataGridCellMouseEventArgs<TItem>> CellContextMenu { get; set; }
| Type | Description |
|---|---|
| EventCallback<DataGridCellMouseEventArgs<TItem>> | Gets or sets the row click callback. |
Gets or sets the cell double click callback.
public EventCallback<DataGridCellMouseEventArgs<TItem>> CellDoubleClick { get; set; }
| Type | Description |
|---|---|
| EventCallback<DataGridCellMouseEventArgs<TItem>> | Gets or sets the cell double click callback. |
Gets or sets the cell render callback. Use it to set cell attributes.
public Action<DataGridCellRenderEventArgs<TItem>> CellRender { get; set; }
| Type | Description |
|---|---|
| Action<DataGridCellRenderEventArgs<TItem>> | Gets or sets the cell render callback. Use it to set cell attributes. |
Gets or sets the clear filter text.
public string ClearFilterText { get; set; }
| Type | Description |
|---|---|
| string | Gets or sets the clear filter text. |
Gets or sets the title attribute of the collapse all button.
public string CollapseAllTitle { get; set; }
| Type | Description |
|---|---|
| string | Gets or sets the title attribute of the collapse all button. |
Gets or sets the column reordered callback.
public EventCallback<DataGridColumnReorderedEventArgs<TItem>> ColumnReordered { get; set; }
| Type | Description |
|---|---|
| EventCallback<DataGridColumnReorderedEventArgs<TItem>> | Gets or sets the column reordered callback. |
Gets or sets the column reordering callback.
public EventCallback<DataGridColumnReorderingEventArgs<TItem>> ColumnReordering { get; set; }
| Type | Description |
|---|---|
| EventCallback<DataGridColumnReorderingEventArgs<TItem>> | Gets or sets the column reordering callback. |
Gets or sets the column resized callback.
public EventCallback<DataGridColumnResizedEventArgs<TItem>> ColumnResized { get; set; }
| Type | Description |
|---|---|
| EventCallback<DataGridColumnResizedEventArgs<TItem>> | Gets or sets the column resized callback. |
Gets or sets the width of all columns.
public string ColumnWidth { get; set; }
| Type | Description |
|---|---|
| string | Gets or sets the width of all columns. |
Gets or sets the columns.
public RenderFragment Columns { get; set; }
| Type | Description |
|---|---|
| RenderFragment | Gets or sets the columns. |
Gets the columns collection.
public IList<RadzenDataGridColumn<TItem>> ColumnsCollection { get; }
| Type | Description |
|---|---|
| IList<RadzenDataGridColumn<TItem>> | Gets the columns collection. |
Gets or sets a value indicating whether user can filter columns in column picker.
public bool ColumnsPickerAllowFiltering { get; set; }
| Type | Description |
|---|---|
| bool | Gets or sets a value indicating whether user can filter columns in column picker. |
Gets or sets the column picker max selected labels.
public int ColumnsPickerMaxSelectedLabels { get; set; }
| Type | Description |
|---|---|
| int | Gets or sets the column picker max selected labels. |
Gets or sets the column picker columns showing text.
public string ColumnsShowingText { get; set; }
| Type | Description |
|---|---|
| string | Gets or sets the column picker columns showing text. |
Gets or sets the column picker columns text.
public string ColumnsText { get; set; }
| Type | Description |
|---|---|
| string | Gets or sets the column picker columns text. |
Gets or sets the contains text.
public string ContainsText { get; set; }
| Type | Description |
|---|---|
| string | Gets or sets the contains text. |
Gets or sets the custom filter operator text.
public string CustomText { get; set; }
| Type | Description |
|---|---|
| string | Gets or sets the custom filter operator text. |
Gets or sets the does not contain text.
public string DoesNotContainText { get; set; }
| Type | Description |
|---|---|
| string | Gets or sets the does not contain text. |
Gets or sets the edit mode.
public DataGridEditMode EditMode { get; set; }
| Type | Description |
|---|---|
| DataGridEditMode | Gets or sets the edit mode. |
Gets or sets the edit template.
public RenderFragment<TItem> EditTemplate { get; set; }
| Type | Description |
|---|---|
| RenderFragment<TItem> | Gets or sets the edit template. |
Gets or sets the empty template shown when Data is empty collection.
public RenderFragment EmptyTemplate { get; set; }
| Type | Description |
|---|---|
| RenderFragment | Gets or sets the empty template shown when Data is empty collection. |
Gets or sets the empty text shown when Data is empty collection.
public string EmptyText { get; set; }
| Type | Description |
|---|---|
| string | Gets or sets the empty text shown when Data is empty collection. |
Gets or sets the ends with text.
public string EndsWithText { get; set; }
| Type | Description |
|---|---|
| string | Gets or sets the ends with text. |
Gets or sets the enum filter select text.
public string EnumFilterSelectText { get; set; }
| Type | Description |
|---|---|
| string | Gets or sets the enum filter select text. |
Allows to define a custom function for enums DisplayAttribute Description property value translation in datagrid Enum filters.
public Func<string, string> EnumFilterTranslationFunc { get; set; }
| Type | Description |
|---|---|
| Func<string, string> | Allows to define a custom function for enums DisplayAttribute Description property value translation in datagrid Enum filters. |
Gets or sets the nullable enum for null value filter text.
public string EnumNullFilterText { get; set; }
| Type | Description |
|---|---|
| string | Gets or sets the nullable enum for null value filter text. |
Gets or sets the equals text.
public string EqualsText { get; set; }
| Type | Description |
|---|---|
| string | Gets or sets the equals text. |
Gets or sets the title attribute of the expand all button.
public string ExpandAllTitle { get; set; }
| Type | Description |
|---|---|
| string | Gets or sets the title attribute of the expand all button. |
Gets or sets the expand child item aria label text.
public string ExpandChildItemAriaLabel { get; set; }
| Type | Description |
|---|---|
| string | Gets or sets the expand child item aria label text. |
Gets or sets the expand group aria label text.
public string ExpandGroupAriaLabel { get; set; }
| Type | Description |
|---|---|
| string | Gets or sets the expand group aria label text. |
Gets or sets the expand mode.
public DataGridExpandMode ExpandMode { get; set; }
| Type | Description |
|---|---|
| DataGridExpandMode | Gets or sets the expand mode. |
Gets or sets the column filter callback.
public EventCallback<DataGridColumnFilterEventArgs<TItem>> Filter { get; set; }
| Type | Description |
|---|---|
| EventCallback<DataGridColumnFilterEventArgs<TItem>> | Gets or sets the column filter callback. |
Gets or sets the filter case sensitivity.
public FilterCaseSensitivity FilterCaseSensitivity { get; set; }
| Type | Description |
|---|---|
| FilterCaseSensitivity | Gets or sets the filter case sensitivity. |
Gets or sets the column filter cleared callback.
public EventCallback<DataGridColumnFilterEventArgs<TItem>> FilterCleared { get; set; }
| Type | Description |
|---|---|
| EventCallback<DataGridColumnFilterEventArgs<TItem>> | Gets or sets the column filter cleared callback. |
Gets or sets the filter date format.
public string FilterDateFormat { get; set; }
| Type | Description |
|---|---|
| string | Gets or sets the filter date format. |
Gets or sets the filter delay.
public int FilterDelay { get; set; }
| Type | Description |
|---|---|
| int | Gets or sets the filter delay. |
Gets or set the filter icon to use.
public string FilterIcon { get; set; }
| Type | Description |
|---|---|
| string | Gets or set the filter icon to use. |
Gets or sets the filter mode.
public FilterMode FilterMode { get; set; }
| Type | Description |
|---|---|
| FilterMode | Gets or sets the filter mode. |
Gets or sets the column filter value aria label text.
public string FilterOperatorAriaLabel { get; set; }
| Type | Description |
|---|---|
| string | Gets or sets the column filter value aria label text. |
Gets or sets the render mode.
public PopupRenderMode FilterPopupRenderMode { get; set; }
| Type | Description |
|---|---|
| PopupRenderMode | Gets or sets the render mode. |
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.
public bool FilterRowActive { get; }
| Type | Description |
|---|---|
| bool | 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. |
Gets or sets the filter text.
public string FilterText { get; set; }
| Type | Description |
|---|---|
| string | Gets or sets the filter text. |
Gets or sets the date simple filter toggle aria label text.
public string FilterToggleAriaLabel { get; set; }
| Type | Description |
|---|---|
| string | Gets or sets the date simple filter toggle aria label text. |
Gets or sets the column filter value aria label text.
public string FilterValueAriaLabel { get; set; }
| Type | Description |
|---|---|
| string | Gets or sets the column filter value aria label text. |
Gets or sets the ability to automatically goto the first page when sorting is changed.
public bool GotoFirstPageOnSort { get; set; }
| Type | Description |
|---|---|
| bool | Gets or sets the ability to automatically goto the first page when sorting is changed. |
Gets or sets the greater than or equals text.
public string GreaterThanOrEqualsText { get; set; }
| Type | Description |
|---|---|
| string | Gets or sets the greater than or equals text. |
Gets or sets the greater than text.
public string GreaterThanText { get; set; }
| Type | Description |
|---|---|
| string | Gets or sets the greater than text. |
Gets or sets the grid lines.
public DataGridGridLines GridLines { get; set; }
| Type | Description |
|---|---|
| DataGridGridLines | Gets or sets the grid lines. |
Gets or sets the column group callback.
public EventCallback<DataGridColumnGroupEventArgs<TItem>> Group { get; set; }
| Type | Description |
|---|---|
| EventCallback<DataGridColumnGroupEventArgs<TItem>> | Gets or sets the column group callback. |
Gets or sets the group header template.
public RenderFragment<Group> GroupHeaderTemplate { get; set; }
| Type | Description |
|---|---|
| RenderFragment<Group> | Gets or sets the group header template. |
Gets or sets the group header with option to add custom toggle visibility button template.
public RenderFragment<ValueTuple<Group, RadzenDataGridGroupRow<TItem>>> GroupHeaderToggleTemplate { get; set; }
| Type | Description |
|---|---|
| RenderFragment<ValueTuple<Group, RadzenDataGridGroupRow<TItem>>> | Gets or sets the group header with option to add custom toggle visibility button template. |
Gets or sets the group panel text.
public string GroupPanelText { get; set; }
| Type | Description |
|---|---|
| string | Gets or sets the group panel text. |
Gets or sets the group row collapse callback.
public EventCallback<Group> GroupRowCollapse { get; set; }
| Type | Description |
|---|---|
| EventCallback<Group> | Gets or sets the group row collapse callback. |
Gets or sets the group row expand callback.
public EventCallback<Group> GroupRowExpand { get; set; }
| Type | Description |
|---|---|
| EventCallback<Group> | Gets or sets the group row expand callback. |
Gets or sets the group row render callback. Use it to set group row attributes.
public Action<GroupRowRenderEventArgs> GroupRowRender { get; set; }
| Type | Description |
|---|---|
| Action<GroupRowRenderEventArgs> | Gets or sets the group row render callback. Use it to set group row attributes. |
Gets the view grouped and paged.
public IEnumerable<GroupResult> GroupedPagedView { get; }
| Type | Description |
|---|---|
| IEnumerable<GroupResult> | Gets the view grouped and paged. |
Gets or sets the group descriptors.
public ObservableCollection<GroupDescriptor> Groups { get; set; }
| Type | Description |
|---|---|
| ObservableCollection<GroupDescriptor> | Gets or sets the group descriptors. |
Gets or sets the header cell render callback. Use it to set header cell attributes.
public Action<DataGridCellRenderEventArgs<TItem>> HeaderCellRender { get; set; }
| Type | Description |
|---|---|
| Action<DataGridCellRenderEventArgs<TItem>> | Gets or sets the header cell render callback. Use it to set header cell attributes. |
Gives the grid a custom header, allowing the adding of components to create custom tool bars in addtion to column grouping and column picker
public RenderFragment HeaderTemplate { get; set; }
| Type | Description |
|---|---|
| RenderFragment | Gives the grid a custom header, allowing the adding of components to create custom tool bars in addtion to column grouping and column picker |
Gets or sets a value indicating whether grouped column should be hidden.
public bool HideGroupedColumn { get; set; }
| Type | Description |
|---|---|
| bool | Gets or sets a value indicating whether grouped column should be hidden. |
Gets or sets the in operator text.
public string InText { get; set; }
| Type | Description |
|---|---|
| string | Gets or sets the in operator text. |
Gets or sets the is empty text.
public string IsEmptyText { get; set; }
| Type | Description |
|---|---|
| string | Gets or sets the is empty text. |
Gets or sets a value indicating whether this instance loading indicator is shown.
public bool IsLoading { get; set; }
| Type | Description |
|---|---|
| bool | Gets or sets a value indicating whether this instance loading indicator is shown. |
Gets or sets the is not empty text.
public string IsNotEmptyText { get; set; }
| Type | Description |
|---|---|
| string | Gets or sets the is not empty text. |
Gets or sets the not null text.
public string IsNotNullText { get; set; }
| Type | Description |
|---|---|
| string | Gets or sets the not null text. |
Gets or sets the is null text.
public string IsNullText { get; set; }
| Type | Description |
|---|---|
| string | Gets or sets the is null text. |
Gets whether all inline edit validators in the DataGrid are currently valid. Use this property to check validation state before saving edited rows.
public bool IsValid { get; }
| Type | Description |
|---|---|
| bool | Gets whether all inline edit validators in the DataGrid are currently valid. Use this property to check validation state before saving edited rows. |
Gets or sets key down callback.
public EventCallback<KeyboardEventArgs> KeyDown { get; set; }
| Type | Description |
|---|---|
| EventCallback<KeyboardEventArgs> | Gets or sets key down callback. |
Gets or sets the key property.
public string KeyProperty { get; set; }
| Type | Description |
|---|---|
| string | Gets or sets the key property. |
Gets or sets the less than or equals text.
public string LessThanOrEqualsText { get; set; }
| Type | Description |
|---|---|
| string | Gets or sets the less than or equals text. |
Gets or sets the less than text.
public string LessThanText { get; set; }
| Type | Description |
|---|---|
| string | Gets or sets the less than text. |
Gets or sets the load child data callback.
public EventCallback<DataGridLoadChildDataEventArgs<TItem>> LoadChildData { get; set; }
| Type | Description |
|---|---|
| EventCallback<DataGridLoadChildDataEventArgs<TItem>> | Gets or sets the load child data callback. |
Gets or sets the callback used to load column filter data for DataGrid FilterMode.CheckBoxList filter mode.
public EventCallback<DataGridLoadColumnFilterDataEventArgs<TItem>> LoadColumnFilterData { get; set; }
| Type | Description |
|---|---|
| EventCallback<DataGridLoadColumnFilterDataEventArgs<TItem>> | Gets or sets the callback used to load column filter data for DataGrid FilterMode.CheckBoxList filter mode. |
Gets or sets the load settings callback.
public Action<DataGridLoadSettingsEventArgs> LoadSettings { get; set; }
| Type | Description |
|---|---|
| Action<DataGridLoadSettingsEventArgs> | Gets or sets the load settings callback. |
Gets or sets the logical filter operator.
public LogicalFilterOperator LogicalFilterOperator { get; set; }
| Type | Description |
|---|---|
| LogicalFilterOperator | Gets or sets the logical filter operator. |
Gets or sets the column logical filter value aria label text.
public string LogicalOperatorAriaLabel { get; set; }
| Type | Description |
|---|---|
| string | Gets or sets the column logical filter value aria label text. |
Gets or sets the not equals text.
public string NotEqualsText { get; set; }
| Type | Description |
|---|---|
| string | Gets or sets the not equals text. |
Gets or sets the not in operator text.
public string NotInText { get; set; }
| Type | Description |
|---|---|
| string | Gets or sets the not in operator text. |
Gets or sets the or operator text.
public string OrOperatorText { get; set; }
| Type | Description |
|---|---|
| string | Gets or sets the or operator text. |
Gets or sets the page size changed callback.
public EventCallback<int> PageSizeChanged { get; set; }
| Type | Description |
|---|---|
| EventCallback<int> | Gets or sets the page size changed callback. |
Gets or sets the picked columns changed callback.
public EventCallback<DataGridPickedColumnsChangedEventArgs<TItem>> PickedColumnsChanged { get; set; }
| Type | Description |
|---|---|
| EventCallback<DataGridPickedColumnsChangedEventArgs<TItem>> | Gets or sets the picked columns changed callback. |
Gets the query.
public Query Query { get; }
| Type | Description |
|---|---|
| Query | Gets the query. |
Gets or sets a value indicating whether only visible columns are included in the query.
public bool QueryOnlyVisibleColumns { get; set; }
| Type | Description |
|---|---|
| bool | Gets or sets a value indicating whether only visible columns are included in the query. |
Gets or sets the remove group button aria label text.
public string RemoveGroupAriaLabel { get; set; }
| Type | Description |
|---|---|
| string | Gets or sets the remove group button aria label text. |
Gets or sets the render callback.
public Action<DataGridRenderEventArgs<TItem>> Render { get; set; }
| Type | Description |
|---|---|
| Action<DataGridRenderEventArgs<TItem>> | Gets or sets the render callback. |
Gets or sets the render async callback.
public Func<DataGridRenderEventArgs<TItem>, Task> RenderAsync { get; set; }
| Type | Description |
|---|---|
| Func<DataGridRenderEventArgs<TItem>, Task> | Gets or sets the render async callback. |
Gets or sets a value indicating whether DataGrid is responsive.
public bool Responsive { get; set; }
| Type | Description |
|---|---|
| bool | Gets or sets a value indicating whether DataGrid is responsive. |
Gets or sets the row click callback.
public EventCallback<DataGridRowMouseEventArgs<TItem>> RowClick { get; set; }
| Type | Description |
|---|---|
| EventCallback<DataGridRowMouseEventArgs<TItem>> | Gets or sets the row click callback. |
Gets or sets the row collapse callback.
public EventCallback<TItem> RowCollapse { get; set; }
| Type | Description |
|---|---|
| EventCallback<TItem> | Gets or sets the row collapse callback. |
Gets or sets the row create callback.
public EventCallback<TItem> RowCreate { get; set; }
| Type | Description |
|---|---|
| EventCallback<TItem> | Gets or sets the row create callback. |
Gets or sets the row deselect callback.
public EventCallback<TItem> RowDeselect { get; set; }
| Type | Description |
|---|---|
| EventCallback<TItem> | Gets or sets the row deselect callback. |
Gets or sets the row double click callback.
public EventCallback<DataGridRowMouseEventArgs<TItem>> RowDoubleClick { get; set; }
| Type | Description |
|---|---|
| EventCallback<DataGridRowMouseEventArgs<TItem>> | Gets or sets the row double click callback. |
Gets or sets the row edit callback.
public EventCallback<TItem> RowEdit { get; set; }
| Type | Description |
|---|---|
| EventCallback<TItem> | Gets or sets the row edit callback. |
Gets or sets the row expand callback.
public EventCallback<TItem> RowExpand { get; set; }
| Type | Description |
|---|---|
| EventCallback<TItem> | Gets or sets the row expand callback. |
Gets or sets the row render callback. Use it to set row attributes.
public Action<RowRenderEventArgs<TItem>> RowRender { get; set; }
| Type | Description |
|---|---|
| Action<RowRenderEventArgs<TItem>> | Gets or sets the row render callback. Use it to set row attributes. |
Gets or sets the row select callback.
public EventCallback<TItem> RowSelect { get; set; }
| Type | Description |
|---|---|
| EventCallback<TItem> | Gets or sets the row select callback. |
Gets or sets the row update callback.
public EventCallback<TItem> RowUpdate { get; set; }
| Type | Description |
|---|---|
| EventCallback<TItem> | Gets or sets the row update callback. |
Gets or sets the column filter value aria label text.
public string SecondFilterOperatorAriaLabel { get; set; }
| Type | Description |
|---|---|
| string | Gets or sets the column filter value aria label text. |
Gets or sets the column filter value aria label text.
public string SecondFilterValueAriaLabel { get; set; }
| Type | Description |
|---|---|
| string | Gets or sets the column filter value aria label text. |
Gets or sets the select visible columns aria label text.
public string SelectVisibleColumnsAriaLabel { get; set; }
| Type | Description |
|---|---|
| string | Gets or sets the select visible columns aria label text. |
Gets or sets the selection mode.
public DataGridSelectionMode SelectionMode { get; set; }
| Type | Description |
|---|---|
| DataGridSelectionMode | Gets or sets the selection mode. |
Gets or sets DataGrid settings.
public DataGridSettings Settings { get; set; }
| Type | Description |
|---|---|
| DataGridSettings | Gets or sets DataGrid settings. |
Gets or sets the settings changed callback.
public EventCallback<DataGridSettings> SettingsChanged { get; set; }
| Type | Description |
|---|---|
| EventCallback<DataGridSettings> | Gets or sets the settings changed callback. |
Gets or sets a value indicating whether cell data should be shown as tooltip.
public bool ShowCellDataAsTooltip { get; set; }
| Type | Description |
|---|---|
| bool | Gets or sets a value indicating whether cell data should be shown as tooltip. |
Gets or sets a value indicating whether column title should be shown as tooltip.
public bool ShowColumnTitleAsTooltip { get; set; }
| Type | Description |
|---|---|
| bool | Gets or sets a value indicating whether column title should be shown as tooltip. |
Gets or sets a value indicating whether DataGrid data body show empty message.
public bool ShowEmptyMessage { get; set; }
| Type | Description |
|---|---|
| bool | Gets or sets a value indicating whether DataGrid data body show empty message. |
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.
public bool ShowExpandAll { get; set; }
| Type | Description |
|---|---|
| bool | 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. |
Gets or sets whether the expandable indicator column is visible.
public bool ShowExpandColumn { get; set; }
| Type | Description |
|---|---|
| bool | Gets or sets whether the expandable indicator column is visible. |
Gets or sets a value indicating whether to show group visibility column
public bool ShowGroupExpandColumn { get; set; }
| Type | Description |
|---|---|
| bool | Gets or sets a value indicating whether to show group visibility column |
Gets or sets value if headers are shown.
public bool ShowHeader { get; set; }
| Type | Description |
|---|---|
| bool | Gets or sets value if headers are shown. |
Gets or sets a value indicating whether multi column sorting index is shown.
public bool ShowMultiColumnSortingIndex { get; set; }
| Type | Description |
|---|---|
| bool | Gets or sets a value indicating whether multi column sorting index is shown. |
Gets or sets the column sort callback.
public EventCallback<DataGridColumnSortEventArgs<TItem>> Sort { get; set; }
| Type | Description |
|---|---|
| EventCallback<DataGridColumnSortEventArgs<TItem>> | Gets or sets the column sort callback. |
Gets or sets the sort descriptors.
public ObservableCollection<SortDescriptor> Sorts { get; set; }
| Type | Description |
|---|---|
| ObservableCollection<SortDescriptor> | Gets or sets the sort descriptors. |
Gets or sets the starts with text.
public string StartsWithText { get; set; }
| Type | Description |
|---|---|
| string | Gets or sets the starts with text. |
Gets or sets the selected item.
public IList<TItem> Value { get; set; }
| Type | Description |
|---|---|
| IList<TItem> | Gets or sets the selected item. |
Gets or sets the value changed callback.
public EventCallback<IList<TItem>> ValueChanged { get; set; }
| Type | Description |
|---|---|
| EventCallback<IList<TItem>> | Gets or sets the value changed callback. |
Gets the view - Data with sorting, filtering and paging applied.
public IQueryable<TItem> View { get; }
| Type | Description |
|---|---|
| IQueryable<TItem> | Gets the view - Data with sorting, filtering and paging applied. |
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.
public int VirtualizationOverscanCount { get; set; }
| Type | Description |
|---|---|
| int | 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. |
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.
public Virtualization.Virtualize<TItem> Virtualize { get; }
| Type | Description |
|---|---|
| Virtualization.Virtualize<TItem> | 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. |
Adds context menu for this component.
protected override Task AddContextMenu()
| Type | Description |
|---|---|
| Task |
Applies the date filter by filter operator.
protected void ApplyDateFilterByFilterOperator(RadzenDataGridColumn<TItem> column, FilterOperator filterOperator)
| Type | Name | Description |
|---|---|---|
| RadzenDataGridColumn<TItem> | column | The column. |
| FilterOperator | filterOperator | The filter operator. |
Apply filter to the specified column
public Task ApplyFilter(RadzenDataGridColumn<TItem> column, bool closePopup)
| Type | Name | Description |
|---|---|---|
| RadzenDataGridColumn<TItem> | column | |
| bool | closePopup |
| Type | Description |
|---|---|
| Task |
protected override void BuildRenderTree(Rendering.RenderTreeBuilder __builder)
| Type | Name | Description |
|---|---|---|
| Rendering.RenderTreeBuilder | __builder |
Cancels the edited row.
public void CancelEditRow(TItem item)
| Type | Name | Description |
|---|---|---|
| TItem | item | The item. |
Cancels the edit of a range of rows.
public void CancelEditRows(IEnumerable<TItem> items)
| Type | Name | Description |
|---|---|---|
| IEnumerable<TItem> | items | The range of rows. |
?lear filter on the specified column
public Task ClearFilter(RadzenDataGridColumn<TItem> column, bool closePopup, bool shouldReload)
| Type | Name | Description |
|---|---|---|
| RadzenDataGridColumn<TItem> | column | |
| bool | closePopup | |
| bool | shouldReload |
| Type | Description |
|---|---|
| Task |
Collapse all rows that are expanded
public Task CollapseAll()
| Type | Description |
|---|---|
| Task |
Collapse a range of rows.
public Task CollapseRows(IEnumerable<TItem> items)
| Type | Name | Description |
|---|---|---|
| IEnumerable<TItem> | items | The range of rows. |
| Type | Description |
|---|---|
| Task |
The filter operator style for dates.
protected string DateFilterOperatorStyle(RadzenDataGridColumn<TItem> column, FilterOperator value)
| Type | Name | Description |
|---|---|---|
| RadzenDataGridColumn<TItem> | column | The column. |
| FilterOperator | value | The value. |
| Type | Description |
|---|---|
| string | System.String. |
Edits the row.
public Task EditRow(TItem item)
| Type | Name | Description |
|---|---|---|
| TItem | item | The item. |
| Type | Description |
|---|---|
| Task |
Edits a range of rows.
public Task EditRows(IEnumerable<TItem> items)
| Type | Name | Description |
|---|---|---|
| IEnumerable<TItem> | items | The range of rows. |
| Type | Description |
|---|---|
| Task |
Expand group item.
public Task ExpandGroupItem(RadzenDataGridGroupRow<TItem> item, bool? expandedOnLoad)
| Type | Name | Description |
|---|---|---|
| RadzenDataGridGroupRow<TItem> | item | |
| bool? | expandedOnLoad |
| Type | Description |
|---|---|
| Task |
Expands the row to show the content defined in Template property.
public Task ExpandRow(TItem item)
| Type | Name | Description |
|---|---|---|
| TItem | item | The item. |
| Type | Description |
|---|---|
| Task |
Expands a range of rows.
public Task ExpandRows(IEnumerable<TItem> items)
| Type | Name | Description |
|---|---|---|
| IEnumerable<TItem> | items | The range of rows. |
| Type | Description |
|---|---|
| Task |
protected override string GetComponentCssClass()
| Type | Description |
|---|---|
| string |
Inserts new row after specific row item.
public Task InsertAfterRow(TItem itemToInsert, TItem rowItem)
| Type | Name | Description |
|---|---|---|
| TItem | itemToInsert | The item. |
| TItem | rowItem | Row item to insert after |
| Type | Description |
|---|---|
| Task |
Inserts new row.
public Task InsertRow(TItem item)
| Type | Name | Description |
|---|---|---|
| TItem | item | The item. |
| Type | Description |
|---|---|
| Task |
Gets boolean value indicating if the row is expanded or not.
public bool IsRowExpanded(TItem item)
| Type | Name | Description |
|---|---|---|
| TItem | item | The item. |
| Type | Description |
|---|---|
| bool |
Determines whether row in edit mode.
public bool IsRowInEditMode(TItem item)
| Type | Name | Description |
|---|---|---|
| TItem | item | The item. |
| Type | Description |
|---|---|
| bool | true if row in edit mode; otherwise, false. |
Compares two items
protected bool ItemEquals(TItem item, TItem otherItem)
| Type | Name | Description |
|---|---|---|
| TItem | item | The first item |
| TItem | otherItem | The second item |
| Type | Description |
|---|---|
| bool | Are items equal |
protected override Task OnAfterRenderAsync(bool firstRender)
| Type | Name | Description |
|---|---|---|
| bool | firstRender |
| Type | Description |
|---|---|
| Task |
Handles the blur event.
protected virtual Task OnBlur(FocusEventArgs args)
| Type | Name | Description |
|---|---|---|
| FocusEventArgs | args | The FocusEventArgs instance containing the event data. |
| Type | Description |
|---|---|
| Task |
protected override void OnCollectionChanged(object sender, Collections.Specialized.NotifyCollectionChangedEventArgs args)
| Type | Name | Description |
|---|---|---|
| object | sender | |
| Collections.Specialized.NotifyCollectionChangedEventArgs | args |
Called when column is resized.
public Task OnColumnResized(int columnIndex, double value)
| Type | Name | Description |
|---|---|---|
| int | columnIndex | Index of the column. |
| double | value | The value. |
| Type | Description |
|---|---|
| Task |
Raises ContextMenu.
public override Task OnContextMenu(MouseEventArgs args)
| Type | Name | Description |
|---|---|---|
| MouseEventArgs | args | The MouseEventArgs instance containing the event data. |
| Type | Description |
|---|---|
| Task |
Called when filter key pressed.
protected virtual Task OnFilter(ChangeEventArgs args, RadzenDataGridColumn<TItem> column, bool force, bool isFirst)
| Type | Name | Description |
|---|---|---|
| ChangeEventArgs | args | The EventArgs instance containing the event data. |
| RadzenDataGridColumn<TItem> | column | The column. |
| bool | force | |
| bool | isFirst |
| Type | Description |
|---|---|
| Task |
Called when filter key pressed.
protected virtual void OnFilterKeyPress(EventArgs args, RadzenDataGridColumn<TItem> column)
| Type | Name | Description |
|---|---|---|
| EventArgs | args | The EventArgs instance containing the event data. |
| RadzenDataGridColumn<TItem> | column | The column. |
Handles the key down event.
protected virtual Task OnKeyDown(KeyboardEventArgs args)
| Type | Name | Description |
|---|---|---|
| KeyboardEventArgs | args | The KeyboardEventArgs instance containing the event data. |
| Type | Description |
|---|---|
| Task |
protected override Task OnPageSizeChanged(int value)
| Type | Name | Description |
|---|---|---|
| int | value |
| Type | Description |
|---|---|
| Task |
Called when parameters set asynchronous.
protected override Task OnParametersSetAsync()
| Type | Description |
|---|---|
| Task | Task. |
Orders the DataGrid by property name.
public void OrderBy(string property)
| Type | Name | Description |
|---|---|---|
| string | property | The property name. |
Orders descending the DataGrid by property name.
public void OrderByDescending(string property)
| Type | Name | Description |
|---|---|---|
| string | property | The property name. |
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.
public Task RefreshDataAsync()
| Type | Description |
|---|---|
| Task | A task representing the asynchronous refresh operation. |
Reloads this instance.
public override Task Reload()
| Type | Description |
|---|---|
| Task |
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.
public Task ReloadSettings(bool forceReload)
| Type | Name | Description |
|---|---|---|
| bool | forceReload | If true, forces a reload of the settings regardless of their current state. Default is false. |
| Type | Description |
|---|---|
| Task |
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.
public void Reset(bool resetColumnState, bool resetRowState)
| Type | Name | Description |
|---|---|---|
| bool | resetColumnState | |
| bool | resetRowState |
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.
public void ResetLoadData()Selects the row.
public Task SelectRow(TItem item, bool raiseEvent)
| Type | Name | Description |
|---|---|---|
| TItem | item | The item. |
| bool | raiseEvent | Should raise RowSelect event. |
| Type | Description |
|---|---|
| Task |
Override this method to customize how filter values are serialized back typed from the settings.
public virtual bool SetColumnFilterValueFromSettings(RadzenDataGridColumn<TItem> gridColumn, DataGridColumnSettings columnSettings, bool isFirst)
| Type | Name | Description |
|---|---|---|
| RadzenDataGridColumn<TItem> | gridColumn | Grid colum to set. |
| DataGridColumnSettings | columnSettings | Setting of the column. |
| bool | isFirst | Handle first or second filter value. |
| Type | Description |
|---|---|
| bool | Returns true if state should update. |
public override Task SetParametersAsync(ParameterView parameters)
| Type | Name | Description |
|---|---|---|
| ParameterView | parameters |
| Type | Description |
|---|---|
| Task |
Updates the row.
public Task UpdateRow(TItem item)
| Type | Name | Description |
|---|---|---|
| TItem | item | The item. |
| Type | Description |
|---|---|
| Task |