RadzenDataGrid<TItem> Class

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.

Inheritance

Object

ComponentBase

RadzenComponent

PagedDataBoundComponent<TItem>

RadzenDataGrid<TItem>

Implements

IComponent

IHandleEvent

IHandleAfterRender

Inherited Members

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

RadzenComponent.OnMouseLeave

RadzenComponent.GetCssClass

RadzenComponent.GetId

RadzenComponent.Debounce

RadzenComponent.RaiseContextMenu

RadzenComponent.RaiseMouseEnter

RadzenComponent.RaiseMouseLeave

RadzenComponent.Attributes

RadzenComponent.Element

RadzenComponent.MouseEnter

RadzenComponent.MouseLeave

RadzenComponent.ContextMenu

RadzenComponent.Culture

RadzenComponent.DefaultCulture

RadzenComponent.Style

RadzenComponent.Visible

RadzenComponent.UniqueID

RadzenComponent.JSRuntime

RadzenComponent.IsJSRuntimeAvailable

RadzenComponent.Reference

RadzenComponent.CurrentStyle

ComponentBase.OnInitializedAsync

ComponentBase.OnParametersSet

ComponentBase.StateHasChanged

ComponentBase.ShouldRender

ComponentBase.OnAfterRender

ComponentBase.InvokeAsync

ComponentBase.DispatchExceptionAsync

ComponentBase.RendererInfo

ComponentBase.Assets

ComponentBase.AssignedRenderMode

Namespace: Radzen.Blazor

Assembly: Radzen.Blazor.dll

Syntax

public class RadzenDataGrid<TItem> : PagedDataBoundComponent<TItem>, IComponent, IHandleEvent, IHandleAfterRender

Type Parameters

Name Description
TItemThe type of data items displayed in the grid. Each row represents one instance of TItem.

Examples

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;
    }
}

Constructors

RadzenDataGrid<TItem>link

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>()

Properties

AllColumnsTextlink

Gets or sets the column picker all columns text.

Declaration
public string AllColumnsText { get; set; }
Property Value
Type Description
stringGets or sets the column picker all columns text.

AllGroupsExpandedlink

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

Declaration
public bool? AllGroupsExpanded { get; set; }
Property Value
Type Description
bool?Gets or sets a value indicating whether all groups should be expanded when DataGrid is grouped.

AllGroupsExpandedChangedlink

Gets or sets the AllGroupsExpanded changed callback.

Declaration
public EventCallback<bool?> AllGroupsExpandedChanged { get; set; }
Property Value
Type Description
EventCallback<bool?>Gets or sets the AllGroupsExpanded changed callback.

AllowAlternatingRowslink

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

Declaration
public bool AllowAlternatingRows { get; set; }
Property Value
Type Description
boolGets or sets a value indicating whether DataGrid should use alternating row styles.

AllowColumnPickinglink

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

Declaration
public bool AllowColumnPicking { get; set; }
Property Value
Type Description
boolGets or sets a value indicating whether column picking is allowed.

AllowColumnReorderlink

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

Declaration
public bool AllowColumnReorder { get; set; }
Property Value
Type Description
boolGets or sets a value indicating whether column reorder is allowed.

AllowColumnResizelink

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

Declaration
public bool AllowColumnResize { get; set; }
Property Value
Type Description
boolGets or sets a value indicating whether column resizing is allowed.

AllowCompositeDataCellslink

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
Type Description
boolGets or sets a value indicating whether DataGrid data cells will follow the header cells structure in composite columns.

AllowFilterDateInputlink

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

Declaration
public bool AllowFilterDateInput { get; set; }
Property Value
Type Description
boolGets or sets a value indicating whether input is allowed in filter DatePicker.

AllowFilteringlink

Gets or sets a value indicating whether filtering is allowed.

Declaration
public bool AllowFiltering { get; set; }
Property Value
Type Description
boolGets or sets a value indicating whether filtering is allowed.

AllowGroupinglink

Gets or sets a value indicating whether grouping is allowed.

Declaration
public bool AllowGrouping { get; set; }
Property Value
Type Description
boolGets or sets a value indicating whether grouping is allowed.

AllowMultiColumnSortinglink

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

Declaration
public bool AllowMultiColumnSorting { get; set; }
Property Value
Type Description
boolGets or sets a value indicating whether multi column sorting is allowed.

AllowPickAllColumnslink

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

Declaration
public bool AllowPickAllColumns { get; set; }
Property Value
Type Description
boolGets or sets a value indicating whether user can pick all columns in column picker.

AllowRowSelectOnRowClicklink

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
boolGets or sets a value indicating whether DataGrid row can be selected on row click.

AllowSortinglink

Gets or sets a value indicating whether sorting is allowed.

Declaration
public bool AllowSorting { get; set; }
Property Value
Type Description
boolGets or sets a value indicating whether sorting is allowed.

AllowVirtualizationlink

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
Type Description
boolGets 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.

AndOperatorTextlink

Gets or sets the and operator text.

Declaration
public string AndOperatorText { get; set; }
Property Value
Type Description
stringGets or sets the and operator text.

ApplyFilterTextlink

Gets or sets the apply filter text.

Declaration
public string ApplyFilterText { get; set; }
Property Value
Type Description
stringGets or sets the apply filter text.

CellClicklink

Gets or sets the cell click callback.

Declaration
public EventCallback<DataGridCellMouseEventArgs<TItem>> CellClick { get; set; }
Property Value
Type Description
EventCallback<DataGridCellMouseEventArgs<TItem>>Gets or sets the cell click callback.

CellContextMenulink

Gets or sets the row click callback.

Declaration
public EventCallback<DataGridCellMouseEventArgs<TItem>> CellContextMenu { get; set; }
Property Value
Type Description
EventCallback<DataGridCellMouseEventArgs<TItem>>Gets or sets the row click callback.

CellDoubleClicklink

Gets or sets the cell double click callback.

Declaration
public EventCallback<DataGridCellMouseEventArgs<TItem>> CellDoubleClick { get; set; }
Property Value
Type Description
EventCallback<DataGridCellMouseEventArgs<TItem>>Gets or sets the cell double click callback.

CellRenderlink

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

Declaration
public Action<DataGridCellRenderEventArgs<TItem>> CellRender { get; set; }
Property Value
Type Description
Action<DataGridCellRenderEventArgs<TItem>>Gets or sets the cell render callback. Use it to set cell attributes.

ClearFilterTextlink

Gets or sets the clear filter text.

Declaration
public string ClearFilterText { get; set; }
Property Value
Type Description
stringGets or sets the clear filter text.

CollapseAllTitlelink

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

Declaration
public string CollapseAllTitle { get; set; }
Property Value
Type Description
stringGets or sets the title attribute of the collapse all button.

ColumnReorderedlink

Gets or sets the column reordered callback.

Declaration
public EventCallback<DataGridColumnReorderedEventArgs<TItem>> ColumnReordered { get; set; }
Property Value
Type Description
EventCallback<DataGridColumnReorderedEventArgs<TItem>>Gets or sets the column reordered callback.

ColumnReorderinglink

Gets or sets the column reordering callback.

Declaration
public EventCallback<DataGridColumnReorderingEventArgs<TItem>> ColumnReordering { get; set; }
Property Value
Type Description
EventCallback<DataGridColumnReorderingEventArgs<TItem>>Gets or sets the column reordering callback.

ColumnResizedlink

Gets or sets the column resized callback.

Declaration
public EventCallback<DataGridColumnResizedEventArgs<TItem>> ColumnResized { get; set; }
Property Value
Type Description
EventCallback<DataGridColumnResizedEventArgs<TItem>>Gets or sets the column resized callback.

ColumnWidthlink

Gets or sets the width of all columns.

Declaration
public string ColumnWidth { get; set; }
Property Value
Type Description
stringGets or sets the width of all columns.

Columnslink

Gets or sets the columns.

Declaration
public RenderFragment Columns { get; set; }
Property Value
Type Description
RenderFragmentGets or sets the columns.

ColumnsCollectionlink

Gets the columns collection.

Declaration
public IList<RadzenDataGridColumn<TItem>> ColumnsCollection { get; }
Property Value
Type Description
IList<RadzenDataGridColumn<TItem>>Gets the columns collection.

ColumnsPickerAllowFilteringlink

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

Declaration
public bool ColumnsPickerAllowFiltering { get; set; }
Property Value
Type Description
boolGets or sets a value indicating whether user can filter columns in column picker.

ColumnsPickerMaxSelectedLabelslink

Gets or sets the column picker max selected labels.

Declaration
public int ColumnsPickerMaxSelectedLabels { get; set; }
Property Value
Type Description
intGets or sets the column picker max selected labels.

ColumnsShowingTextlink

Gets or sets the column picker columns showing text.

Declaration
public string ColumnsShowingText { get; set; }
Property Value
Type Description
stringGets or sets the column picker columns showing text.

ColumnsTextlink

Gets or sets the column picker columns text.

Declaration
public string ColumnsText { get; set; }
Property Value
Type Description
stringGets or sets the column picker columns text.

ContainsTextlink

Gets or sets the contains text.

Declaration
public string ContainsText { get; set; }
Property Value
Type Description
stringGets or sets the contains text.

CustomTextlink

Gets or sets the custom filter operator text.

Declaration
public string CustomText { get; set; }
Property Value
Type Description
stringGets or sets the custom filter operator text.

DoesNotContainTextlink

Gets or sets the does not contain text.

Declaration
public string DoesNotContainText { get; set; }
Property Value
Type Description
stringGets or sets the does not contain text.

EditModelink

Gets or sets the edit mode.

Declaration
public DataGridEditMode EditMode { get; set; }
Property Value
Type Description
DataGridEditModeGets or sets the edit mode.

EditTemplatelink

Gets or sets the edit template.

Declaration
public RenderFragment<TItem> EditTemplate { get; set; }
Property Value
Type Description
RenderFragment<TItem>Gets or sets the edit template.

EmptyTemplatelink

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

Declaration
public RenderFragment EmptyTemplate { get; set; }
Property Value
Type Description
RenderFragmentGets or sets the empty template shown when Data is empty collection.

EmptyTextlink

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

Declaration
public string EmptyText { get; set; }
Property Value
Type Description
stringGets or sets the empty text shown when Data is empty collection.

EndsWithTextlink

Gets or sets the ends with text.

Declaration
public string EndsWithText { get; set; }
Property Value
Type Description
stringGets or sets the ends with text.

EnumFilterSelectTextlink

Gets or sets the enum filter select text.

Declaration
public string EnumFilterSelectText { get; set; }
Property Value
Type Description
stringGets or sets the enum filter select text.

EnumFilterTranslationFunclink

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
Type Description
Func<string, string>Allows to define a custom function for enums DisplayAttribute Description property value translation in datagrid Enum filters.

EnumNullFilterTextlink

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

Declaration
public string EnumNullFilterText { get; set; }
Property Value
Type Description
stringGets or sets the nullable enum for null value filter text.

EqualsTextlink

Gets or sets the equals text.

Declaration
public string EqualsText { get; set; }
Property Value
Type Description
stringGets or sets the equals text.

ExpandAllTitlelink

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

Declaration
public string ExpandAllTitle { get; set; }
Property Value
Type Description
stringGets or sets the title attribute of the expand all button.

ExpandChildItemAriaLabellink

Gets or sets the expand child item aria label text.

Declaration
public string ExpandChildItemAriaLabel { get; set; }
Property Value
Type Description
stringGets or sets the expand child item aria label text.

ExpandGroupAriaLabellink

Gets or sets the expand group aria label text.

Declaration
public string ExpandGroupAriaLabel { get; set; }
Property Value
Type Description
stringGets or sets the expand group aria label text.

ExpandModelink

Gets or sets the expand mode.

Declaration
public DataGridExpandMode ExpandMode { get; set; }
Property Value
Type Description
DataGridExpandModeGets or sets the expand mode.

Filterlink

Gets or sets the column filter callback.

Declaration
public EventCallback<DataGridColumnFilterEventArgs<TItem>> Filter { get; set; }
Property Value
Type Description
EventCallback<DataGridColumnFilterEventArgs<TItem>>Gets or sets the column filter callback.

FilterCaseSensitivitylink

Gets or sets the filter case sensitivity.

Declaration
public FilterCaseSensitivity FilterCaseSensitivity { get; set; }
Property Value
Type Description
FilterCaseSensitivityGets or sets the filter case sensitivity.

FilterClearedlink

Gets or sets the column filter cleared callback.

Declaration
public EventCallback<DataGridColumnFilterEventArgs<TItem>> FilterCleared { get; set; }
Property Value
Type Description
EventCallback<DataGridColumnFilterEventArgs<TItem>>Gets or sets the column filter cleared callback.

FilterDateFormatlink

Gets or sets the filter date format.

Declaration
public string FilterDateFormat { get; set; }
Property Value
Type Description
stringGets or sets the filter date format.

FilterDelaylink

Gets or sets the filter delay.

Declaration
public int FilterDelay { get; set; }
Property Value
Type Description
intGets or sets the filter delay.

FilterIconlink

Gets or set the filter icon to use.

Declaration
public string FilterIcon { get; set; }
Property Value
Type Description
stringGets or set the filter icon to use.

FilterModelink

Gets or sets the filter mode.

Declaration
public FilterMode FilterMode { get; set; }
Property Value
Type Description
FilterModeGets or sets the filter mode.

FilterOperatorAriaLabellink

Gets or sets the column filter value aria label text.

Declaration
public string FilterOperatorAriaLabel { get; set; }
Property Value
Type Description
stringGets or sets the column filter value aria label text.

FilterPopupRenderModelink

Gets or sets the render mode.

Declaration
public PopupRenderMode FilterPopupRenderMode { get; set; }
Property Value
Type Description
PopupRenderModeGets or sets the render mode.

FilterRowActivelink

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
Type Description
boolGets 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.

FilterTextlink

Gets or sets the filter text.

Declaration
public string FilterText { get; set; }
Property Value
Type Description
stringGets or sets the filter text.

FilterToggleAriaLabellink

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

Declaration
public string FilterToggleAriaLabel { get; set; }
Property Value
Type Description
stringGets or sets the date simple filter toggle aria label text.

FilterValueAriaLabellink

Gets or sets the column filter value aria label text.

Declaration
public string FilterValueAriaLabel { get; set; }
Property Value
Type Description
stringGets or sets the column filter value aria label text.

FooterCellRenderlink

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
Type Description
Action<DataGridCellRenderEventArgs<TItem>>Gets or sets the footer cell render callback. Use it to set footer cell attributes.

FooterTemplatelink

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
Type Description
RenderFragmentGives the grid a custom footer, allowing the adding of components to create custom tool bars or custom pagination

GotoFirstPageOnSortlink

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

Declaration
public bool GotoFirstPageOnSort { get; set; }
Property Value
Type Description
boolGets or sets the ability to automatically goto the first page when sorting is changed.

GreaterThanOrEqualsTextlink

Gets or sets the greater than or equals text.

Declaration
public string GreaterThanOrEqualsText { get; set; }
Property Value
Type Description
stringGets or sets the greater than or equals text.

GreaterThanTextlink

Gets or sets the greater than text.

Declaration
public string GreaterThanText { get; set; }
Property Value
Type Description
stringGets or sets the greater than text.

GridLineslink

Gets or sets the grid lines.

Declaration
public DataGridGridLines GridLines { get; set; }
Property Value
Type Description
DataGridGridLinesGets or sets the grid lines.

Grouplink

Gets or sets the column group callback.

Declaration
public EventCallback<DataGridColumnGroupEventArgs<TItem>> Group { get; set; }
Property Value
Type Description
EventCallback<DataGridColumnGroupEventArgs<TItem>>Gets or sets the column group callback.

GroupFootersAlwaysVisiblelink

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
Type Description
boolGets or sets a value indicating whether group footers are visible even when the group is collapsed.

GroupHeaderTemplatelink

Gets or sets the group header template.

Declaration
public RenderFragment<Group> GroupHeaderTemplate { get; set; }
Property Value
Type Description
RenderFragment<Group>Gets or sets the group header template.

GroupHeaderToggleTemplatelink

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
Type Description
RenderFragment<ValueTuple<Group, RadzenDataGridGroupRow<TItem>>>Gets or sets the group header with option to add custom toggle visibility button template.

GroupPanelTextlink

Gets or sets the group panel text.

Declaration
public string GroupPanelText { get; set; }
Property Value
Type Description
stringGets or sets the group panel text.

GroupRowCollapselink

Gets or sets the group row collapse callback.

Declaration
public EventCallback<Group> GroupRowCollapse { get; set; }
Property Value
Type Description
EventCallback<Group>Gets or sets the group row collapse callback.

GroupRowExpandlink

Gets or sets the group row expand callback.

Declaration
public EventCallback<Group> GroupRowExpand { get; set; }
Property Value
Type Description
EventCallback<Group>Gets or sets the group row expand callback.

GroupRowRenderlink

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

Declaration
public Action<GroupRowRenderEventArgs> GroupRowRender { get; set; }
Property Value
Type Description
Action<GroupRowRenderEventArgs>Gets or sets the group row render callback. Use it to set group row attributes.

GroupedPagedViewlink

Gets the view grouped and paged.

Declaration
public IEnumerable<GroupResult> GroupedPagedView { get; }
Property Value
Type Description
IEnumerable<GroupResult>Gets the view grouped and paged.

Groupslink

Gets or sets the group descriptors.

Declaration
public ObservableCollection<GroupDescriptor> Groups { get; set; }
Property Value
Type Description
ObservableCollection<GroupDescriptor>Gets or sets the group descriptors.

HeaderCellRenderlink

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
Type Description
Action<DataGridCellRenderEventArgs<TItem>>Gets or sets the header cell render callback. Use it to set header cell attributes.

HeaderTemplatelink

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
Type Description
RenderFragmentGives the grid a custom header, allowing the adding of components to create custom tool bars in addtion to column grouping and column picker

HideGroupedColumnlink

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

Declaration
public bool HideGroupedColumn { get; set; }
Property Value
Type Description
boolGets or sets a value indicating whether grouped column should be hidden.

InTextlink

Gets or sets the in operator text.

Declaration
public string InText { get; set; }
Property Value
Type Description
stringGets or sets the in operator text.

IsEmptyTextlink

Gets or sets the is empty text.

Declaration
public string IsEmptyText { get; set; }
Property Value
Type Description
stringGets or sets the is empty text.

IsLoadinglink

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

Declaration
public bool IsLoading { get; set; }
Property Value
Type Description
boolGets or sets a value indicating whether this instance loading indicator is shown.

IsNotEmptyTextlink

Gets or sets the is not empty text.

Declaration
public string IsNotEmptyText { get; set; }
Property Value
Type Description
stringGets or sets the is not empty text.

IsNotNullTextlink

Gets or sets the not null text.

Declaration
public string IsNotNullText { get; set; }
Property Value
Type Description
stringGets or sets the not null text.

IsNullTextlink

Gets or sets the is null text.

Declaration
public string IsNullText { get; set; }
Property Value
Type Description
stringGets or sets the is null text.

IsValidlink

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
Type Description
boolGets whether all inline edit validators in the DataGrid are currently valid. Use this property to check validation state before saving edited rows.

KeyDownlink

Gets or sets key down callback.

Declaration
public EventCallback<KeyboardEventArgs> KeyDown { get; set; }
Property Value
Type Description
EventCallback<KeyboardEventArgs>Gets or sets key down callback.

KeyPropertylink

Gets or sets the key property.

Declaration
public string KeyProperty { get; set; }
Property Value
Type Description
stringGets or sets the key property.

LessThanOrEqualsTextlink

Gets or sets the less than or equals text.

Declaration
public string LessThanOrEqualsText { get; set; }
Property Value
Type Description
stringGets or sets the less than or equals text.

LessThanTextlink

Gets or sets the less than text.

Declaration
public string LessThanText { get; set; }
Property Value
Type Description
stringGets or sets the less than text.

LoadChildDatalink

Gets or sets the load child data callback.

Declaration
public EventCallback<DataGridLoadChildDataEventArgs<TItem>> LoadChildData { get; set; }
Property Value
Type Description
EventCallback<DataGridLoadChildDataEventArgs<TItem>>Gets or sets the load child data callback.

LoadColumnFilterDatalink

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
Type Description
EventCallback<DataGridLoadColumnFilterDataEventArgs<TItem>>Gets or sets the callback used to load column filter data for DataGrid FilterMode.CheckBoxList filter mode.

LoadSettingslink

Gets or sets the load settings callback.

Declaration
public Action<DataGridLoadSettingsEventArgs> LoadSettings { get; set; }
Property Value
Type Description
Action<DataGridLoadSettingsEventArgs>Gets or sets the load settings callback.

LogicalFilterOperatorlink

Gets or sets the logical filter operator.

Declaration
public LogicalFilterOperator LogicalFilterOperator { get; set; }
Property Value
Type Description
LogicalFilterOperatorGets or sets the logical filter operator.

LogicalOperatorAriaLabellink

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

Declaration
public string LogicalOperatorAriaLabel { get; set; }
Property Value
Type Description
stringGets or sets the column logical filter value aria label text.

NotEqualsTextlink

Gets or sets the not equals text.

Declaration
public string NotEqualsText { get; set; }
Property Value
Type Description
stringGets or sets the not equals text.

NotInTextlink

Gets or sets the not in operator text.

Declaration
public string NotInText { get; set; }
Property Value
Type Description
stringGets or sets the not in operator text.

OrOperatorTextlink

Gets or sets the or operator text.

Declaration
public string OrOperatorText { get; set; }
Property Value
Type Description
stringGets or sets the or operator text.

PageSizeChangedlink

Gets or sets the page size changed callback.

Declaration
public EventCallback<int> PageSizeChanged { get; set; }
Property Value
Type Description
EventCallback<int>Gets or sets the page size changed callback.

PickedColumnsChangedlink

Gets or sets the picked columns changed callback.

Declaration
public EventCallback<DataGridPickedColumnsChangedEventArgs<TItem>> PickedColumnsChanged { get; set; }
Property Value
Type Description
EventCallback<DataGridPickedColumnsChangedEventArgs<TItem>>Gets or sets the picked columns changed callback.

Querylink

Gets the query.

Declaration
public Query Query { get; }
Property Value
Type Description
QueryGets the query.

QueryOnlyVisibleColumnslink

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

Declaration
public bool QueryOnlyVisibleColumns { get; set; }
Property Value
Type Description
boolGets or sets a value indicating whether only visible columns are included in the query.

RemoveGroupAriaLabellink

Gets or sets the remove group button aria label text.

Declaration
public string RemoveGroupAriaLabel { get; set; }
Property Value
Type Description
stringGets or sets the remove group button aria label text.

Renderlink

Gets or sets the render callback.

Declaration
public Action<DataGridRenderEventArgs<TItem>> Render { get; set; }
Property Value
Type Description
Action<DataGridRenderEventArgs<TItem>>Gets or sets the render callback.

RenderAsynclink

Gets or sets the render async callback.

Declaration
public Func<DataGridRenderEventArgs<TItem>, Task> RenderAsync { get; set; }
Property Value
Type Description
Func<DataGridRenderEventArgs<TItem>, Task>Gets or sets the render async callback.

Responsivelink

Gets or sets a value indicating whether DataGrid is responsive.

Declaration
public bool Responsive { get; set; }
Property Value
Type Description
boolGets or sets a value indicating whether DataGrid is responsive.

RowClicklink

Gets or sets the row click callback.

Declaration
public EventCallback<DataGridRowMouseEventArgs<TItem>> RowClick { get; set; }
Property Value
Type Description
EventCallback<DataGridRowMouseEventArgs<TItem>>Gets or sets the row click callback.

RowCollapselink

Gets or sets the row collapse callback.

Declaration
public EventCallback<TItem> RowCollapse { get; set; }
Property Value
Type Description
EventCallback<TItem>Gets or sets the row collapse callback.

RowCreatelink

Gets or sets the row create callback.

Declaration
public EventCallback<TItem> RowCreate { get; set; }
Property Value
Type Description
EventCallback<TItem>Gets or sets the row create callback.

RowDeselectlink

Gets or sets the row deselect callback.

Declaration
public EventCallback<TItem> RowDeselect { get; set; }
Property Value
Type Description
EventCallback<TItem>Gets or sets the row deselect callback.

RowDoubleClicklink

Gets or sets the row double click callback.

Declaration
public EventCallback<DataGridRowMouseEventArgs<TItem>> RowDoubleClick { get; set; }
Property Value
Type Description
EventCallback<DataGridRowMouseEventArgs<TItem>>Gets or sets the row double click callback.

RowEditlink

Gets or sets the row edit callback.

Declaration
public EventCallback<TItem> RowEdit { get; set; }
Property Value
Type Description
EventCallback<TItem>Gets or sets the row edit callback.

RowExpandlink

Gets or sets the row expand callback.

Declaration
public EventCallback<TItem> RowExpand { get; set; }
Property Value
Type Description
EventCallback<TItem>Gets or sets the row expand callback.

RowRenderlink

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

Declaration
public Action<RowRenderEventArgs<TItem>> RowRender { get; set; }
Property Value
Type Description
Action<RowRenderEventArgs<TItem>>Gets or sets the row render callback. Use it to set row attributes.

RowSelectlink

Gets or sets the row select callback.

Declaration
public EventCallback<TItem> RowSelect { get; set; }
Property Value
Type Description
EventCallback<TItem>Gets or sets the row select callback.

RowUpdatelink

Gets or sets the row update callback.

Declaration
public EventCallback<TItem> RowUpdate { get; set; }
Property Value
Type Description
EventCallback<TItem>Gets or sets the row update callback.

SecondFilterOperatorAriaLabellink

Gets or sets the column filter value aria label text.

Declaration
public string SecondFilterOperatorAriaLabel { get; set; }
Property Value
Type Description
stringGets or sets the column filter value aria label text.

SecondFilterValueAriaLabellink

Gets or sets the column filter value aria label text.

Declaration
public string SecondFilterValueAriaLabel { get; set; }
Property Value
Type Description
stringGets or sets the column filter value aria label text.

SelectVisibleColumnsAriaLabellink

Gets or sets the select visible columns aria label text.

Declaration
public string SelectVisibleColumnsAriaLabel { get; set; }
Property Value
Type Description
stringGets or sets the select visible columns aria label text.

SelectionModelink

Gets or sets the selection mode.

Declaration
public DataGridSelectionMode SelectionMode { get; set; }
Property Value
Type Description
DataGridSelectionModeGets or sets the selection mode.

Settingslink

Gets or sets DataGrid settings.

Declaration
public DataGridSettings Settings { get; set; }
Property Value
Type Description
DataGridSettingsGets or sets DataGrid settings.

SettingsChangedlink

Gets or sets the settings changed callback.

Declaration
public EventCallback<DataGridSettings> SettingsChanged { get; set; }
Property Value
Type Description
EventCallback<DataGridSettings>Gets or sets the settings changed callback.

ShowCellDataAsTooltiplink

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

Declaration
public bool ShowCellDataAsTooltip { get; set; }
Property Value
Type Description
boolGets or sets a value indicating whether cell data should be shown as tooltip.

ShowColumnTitleAsTooltiplink

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

Declaration
public bool ShowColumnTitleAsTooltip { get; set; }
Property Value
Type Description
boolGets or sets a value indicating whether column title should be shown as tooltip.

ShowEmptyMessagelink

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

Declaration
public bool ShowEmptyMessage { get; set; }
Property Value
Type Description
boolGets or sets a value indicating whether DataGrid data body show empty message.

ShowExpandAlllink

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
Type Description
boolGets 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.

ShowExpandColumnlink

Gets or sets whether the expandable indicator column is visible.

Declaration
public bool ShowExpandColumn { get; set; }
Property Value
Type Description
boolGets or sets whether the expandable indicator column is visible.

ShowGroupExpandColumnlink

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

Declaration
public bool ShowGroupExpandColumn { get; set; }
Property Value
Type Description
boolGets or sets a value indicating whether to show group visibility column

ShowHeaderlink

Gets or sets value if headers are shown.

Declaration
public bool ShowHeader { get; set; }
Property Value
Type Description
boolGets or sets value if headers are shown.

ShowMultiColumnSortingIndexlink

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

Declaration
public bool ShowMultiColumnSortingIndex { get; set; }
Property Value
Type Description
boolGets or sets a value indicating whether multi column sorting index is shown.

Sortlink

Gets or sets the column sort callback.

Declaration
public EventCallback<DataGridColumnSortEventArgs<TItem>> Sort { get; set; }
Property Value
Type Description
EventCallback<DataGridColumnSortEventArgs<TItem>>Gets or sets the column sort callback.

Sortslink

Gets or sets the sort descriptors.

Declaration
public ObservableCollection<SortDescriptor> Sorts { get; set; }
Property Value
Type Description
ObservableCollection<SortDescriptor>Gets or sets the sort descriptors.

StartsWithTextlink

Gets or sets the starts with text.

Declaration
public string StartsWithText { get; set; }
Property Value
Type Description
stringGets or sets the starts with text.

Valuelink

Gets or sets the selected item.

Declaration
public IList<TItem> Value { get; set; }
Property Value
Type Description
IList<TItem>Gets or sets the selected item.

ValueChangedlink

Gets or sets the value changed callback.

Declaration
public EventCallback<IList<TItem>> ValueChanged { get; set; }
Property Value
Type Description
EventCallback<IList<TItem>>Gets or sets the value changed callback.

Viewlink

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

Declaration
public IQueryable<TItem> View { get; }
Property Value
Type Description
IQueryable<TItem>Gets the view - Data with sorting, filtering and paging applied.

VirtualizationOverscanCountlink

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
Type Description
intGets 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.

Virtualizelink

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

Methods

AddContextMenulink

Adds context menu for this component.

Declaration
protected override Task AddContextMenu()
Returns
Type Description
Task

ApplyDateFilterByFilterOperatorlink

Applies the date filter by filter operator.

Declaration
protected void ApplyDateFilterByFilterOperator(RadzenDataGridColumn<TItem> column, FilterOperator filterOperator)
Parameters
Type Name Description
RadzenDataGridColumn<TItem> column The column.
FilterOperator filterOperator The filter operator.

ApplyFilterlink

Apply filter to the specified column

Declaration
public Task ApplyFilter(RadzenDataGridColumn<TItem> column, bool closePopup)
Parameters
Type Name Description
RadzenDataGridColumn<TItem> column
bool closePopup
Returns
Type Description
Task

BuildRenderTreelink

Declaration
protected override void BuildRenderTree(Rendering.RenderTreeBuilder __builder)
Parameters
Type Name Description
Rendering.RenderTreeBuilder __builder

CancelEditRowlink

Cancels the edited row.

Declaration
public void CancelEditRow(TItem item)
Parameters
Type Name Description
TItem item The item.

CancelEditRowslink

Cancels the edit of a range of rows.

Declaration
public void CancelEditRows(IEnumerable<TItem> items)
Parameters
Type Name Description
IEnumerable<TItem> items The range of rows.

ClearFilterlink

?lear filter on the specified column

Declaration
public Task ClearFilter(RadzenDataGridColumn<TItem> column, bool closePopup, bool shouldReload)
Parameters
Type Name Description
RadzenDataGridColumn<TItem> column
bool closePopup
bool shouldReload
Returns
Type Description
Task

CollapseAlllink

Collapse all rows that are expanded

Declaration
public Task CollapseAll()
Returns
Type Description
Task

CollapseRowslink

Collapse a range of rows.

Declaration
public Task CollapseRows(IEnumerable<TItem> items)
Parameters
Type Name Description
IEnumerable<TItem> items The range of rows.
Returns
Type Description
Task

DateFilterOperatorStylelink

The filter operator style for dates.

Declaration
protected string DateFilterOperatorStyle(RadzenDataGridColumn<TItem> column, FilterOperator value)
Parameters
Type Name Description
RadzenDataGridColumn<TItem> column The column.
FilterOperator value The value.
Returns
Type Description
stringSystem.String.

Disposelink

Declaration
public override void Dispose()

EditRowlink

Edits the row.

Declaration
public Task EditRow(TItem item)
Parameters
Type Name Description
TItem item The item.
Returns
Type Description
Task

EditRowslink

Edits a range of rows.

Declaration
public Task EditRows(IEnumerable<TItem> items)
Parameters
Type Name Description
IEnumerable<TItem> items The range of rows.
Returns
Type Description
Task

ExpandGroupItemlink

Expand group item.

Declaration
public Task ExpandGroupItem(RadzenDataGridGroupRow<TItem> item, bool? expandedOnLoad)
Parameters
Type Name Description
RadzenDataGridGroupRow<TItem> item
bool? expandedOnLoad
Returns
Type Description
Task

ExpandRowlink

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

Declaration
public Task ExpandRow(TItem item)
Parameters
Type Name Description
TItem item The item.
Returns
Type Description
Task

ExpandRowslink

Expands a range of rows.

Declaration
public Task ExpandRows(IEnumerable<TItem> items)
Parameters
Type Name Description
IEnumerable<TItem> items The range of rows.
Returns
Type Description
Task

GetComponentCssClasslink

Declaration
protected override string GetComponentCssClass()
Returns
Type Description
string

InsertAfterRowlink

Inserts new row after specific row item.

Declaration
public Task InsertAfterRow(TItem itemToInsert, TItem rowItem)
Parameters
Type Name Description
TItem itemToInsert The item.
TItem rowItem Row item to insert after
Returns
Type Description
Task

InsertRowlink

Inserts new row.

Declaration
public Task InsertRow(TItem item)
Parameters
Type Name Description
TItem item The item.
Returns
Type Description
Task

IsRowExpandedlink

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

Declaration
public bool IsRowExpanded(TItem item)
Parameters
Type Name Description
TItem item The item.
Returns
Type Description
bool

IsRowInEditModelink

Determines whether row in edit mode.

Declaration
public bool IsRowInEditMode(TItem item)
Parameters
Type Name Description
TItem item The item.
Returns
Type Description
booltrue if row in edit mode; otherwise, false.

ItemEqualslink

Compares two items

Declaration
protected bool ItemEquals(TItem item, TItem otherItem)
Parameters
Type Name Description
TItem item The first item
TItem otherItem The second item
Returns
Type Description
boolAre items equal

OnAfterRenderAsynclink

Declaration
protected override Task OnAfterRenderAsync(bool firstRender)
Parameters
Type Name Description
bool firstRender
Returns
Type Description
Task

OnBecameInvisiblelink

Declaration
protected override void OnBecameInvisible()

OnBlurlink

Handles the blur event.

Declaration
protected virtual Task OnBlur(FocusEventArgs args)
Parameters
Type Name Description
FocusEventArgs args The FocusEventArgs instance containing the event data.
Returns
Type Description
Task

OnCollectionChangedlink

Declaration
protected override void OnCollectionChanged(object sender, Collections.Specialized.NotifyCollectionChangedEventArgs args)
Parameters
Type Name Description
object sender
Collections.Specialized.NotifyCollectionChangedEventArgs args

OnColumnResizedlink

Called when column is resized.

Declaration
public Task OnColumnResized(int columnIndex, double value)
Parameters
Type Name Description
int columnIndex Index of the column.
double value The value.
Returns
Type Description
Task

OnContextMenulink

Raises ContextMenu.

Declaration
public override Task OnContextMenu(MouseEventArgs args)
Parameters
Type Name Description
MouseEventArgs args The MouseEventArgs instance containing the event data.
Returns
Type Description
Task

OnDataChangedlink

Called when data is changed.

Declaration
protected override void OnDataChanged()

OnFilterlink

Called when filter key pressed.

Declaration
protected virtual Task OnFilter(ChangeEventArgs args, RadzenDataGridColumn<TItem> column, bool force, bool isFirst)
Parameters
Type Name Description
ChangeEventArgs args The EventArgs instance containing the event data.
RadzenDataGridColumn<TItem> column The column.
bool force
bool isFirst
Returns
Type Description
Task

OnFilterKeyPresslink

Called when filter key pressed.

Declaration
protected virtual void OnFilterKeyPress(EventArgs args, RadzenDataGridColumn<TItem> column)
Parameters
Type Name Description
EventArgs args The EventArgs instance containing the event data.
RadzenDataGridColumn<TItem> column The column.

OnInitializedlink

Declaration
protected override void OnInitialized()

OnKeyDownlink

Handles the key down event.

Declaration
protected virtual Task OnKeyDown(KeyboardEventArgs args)
Parameters
Type Name Description
KeyboardEventArgs args The KeyboardEventArgs instance containing the event data.
Returns
Type Description
Task

OnPageSizeChangedlink

Declaration
protected override Task OnPageSizeChanged(int value)
Parameters
Type Name Description
int value
Returns
Type Description
Task

OnParametersSetAsynclink

Called when parameters set asynchronous.

Declaration
protected override Task OnParametersSetAsync()
Returns
Type Description
TaskTask.

OrderBylink

Orders the DataGrid by property name.

Declaration
public void OrderBy(string property)
Parameters
Type Name Description
string property The property name.

OrderByDescendinglink

Orders descending the DataGrid by property name.

Declaration
public void OrderByDescending(string property)
Parameters
Type Name Description
string property The property name.

RefreshDataAsynclink

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
Type Description
TaskA task representing the asynchronous refresh operation.

Reloadlink

Reloads this instance.

Declaration
public override Task Reload()
Returns
Type Description
Task

ReloadSettingslink

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
Type Name Description
bool forceReload If true, forces a reload of the settings regardless of their current state. Default is false.
Returns
Type Description
Task

Resetlink

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
Type Name Description
bool resetColumnState
bool resetRowState

ResetLoadDatalink

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()

SaveSettingslink

Saves DataGrid settings as JSON string.

Declaration
public void SaveSettings()

SelectRowlink

Selects the row.

Declaration
public Task SelectRow(TItem item, bool raiseEvent)
Parameters
Type Name Description
TItem item The item.
bool raiseEvent Should raise RowSelect event.
Returns
Type Description
Task

SetColumnFilterValueFromSettingslink

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
Type Name Description
RadzenDataGridColumn<TItem> gridColumn Grid colum to set.
DataGridColumnSettings columnSettings Setting of the column.
bool isFirst Handle first or second filter value.
Returns
Type Description
boolReturns true if state should update.

SetParametersAsynclink

Declaration
public override Task SetParametersAsync(ParameterView parameters)
Parameters
Type Name Description
ParameterView parameters
Returns
Type Description
Task

UpdatePickableColumnslink

Updates pickable columns.

Declaration
public void UpdatePickableColumns()

UpdateRowlink

Updates the row.

Declaration
public Task UpdateRow(TItem item)
Parameters
Type Name Description
TItem item The item.
Returns
Type Description
Task
An error has occurred. This app may no longer respond until reloaded. Reload 🗙