Table of Contents

Class RadzenDataGrid<TItem>

Namespace
Radzen.Blazor
Assembly
Radzen.Blazor.dll

RadzenDataGrid component.

[CascadingTypeParameter("TItem")]
public class RadzenDataGrid<TItem> : PagedDataBoundComponent<TItem>, IComponent, IHandleEvent, IHandleAfterRender, IDisposable

Type Parameters

TItem

The type of the DataGrid data item.

Inheritance
RadzenDataGrid<TItem>
Implements
Inherited Members

Examples

<RadzenDataGrid @data=@orders TItem="Order" AllowSorting="true" AllowPaging="true" AllowFiltering="true">
    <Columns>
        <RadzenDataGridColumn TItem="Order" Property="OrderId" Title="OrderId" />
        <RadzenDataGridColumn TItem="Order" Property="OrderDate" Title="OrderDate" />
    </Columns>
</RadzenDataGrid>

Constructors

RadzenDataGrid() 

public RadzenDataGrid()

Properties

AllColumnsText

Gets or sets the column picker all columns text.

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

Property Value

string

The column picker all columns text.

AllGroupsExpanded

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

[Parameter]
public bool? AllGroupsExpanded { get; set; }

Property Value

bool?

true if groups are expanded; otherwise, false.

AllGroupsExpandedChanged

Gets or sets the AllGroupsExpanded changed callback.

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

Property Value

EventCallback<bool?>

The AllGroupsExpanded changed callback.

AllowAlternatingRows

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

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

Property Value

bool

true if DataGrid is using alternating row styles; otherwise, false.

AllowColumnPicking

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

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

Property Value

bool

true if column picking is allowed; otherwise, false.

AllowColumnReorder

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

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

Property Value

bool

true if column reorder is allowed; otherwise, false.

AllowColumnResize

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

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

Property Value

bool

true if column resizing is allowed; otherwise, false.

AllowCompositeDataCells

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

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

Property Value

bool

true if DataGrid data cells will follow the header cells structure in composite columns; otherwise, false.

AllowFilterDateInput

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

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

Property Value

bool

true if input is allowed in filter DatePicker; otherwise, false.

AllowFiltering

Gets or sets a value indicating whether filtering is allowed.

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

Property Value

bool

true if filtering is allowed; otherwise, false.

AllowGrouping

Gets or sets a value indicating whether grouping is allowed.

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

Property Value

bool

true if grouping is allowed; otherwise, false.

AllowMultiColumnSorting

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

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

Property Value

bool

true if multi column sorting is allowed; otherwise, false.

AllowPickAllColumns

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

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

Property Value

bool

true if pick of all columns is allowed; otherwise, false.

AllowRowSelectOnRowClick

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

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

Property Value

bool

true if DataGrid row can be selected on row click; otherwise, false.

AllowSorting

Gets or sets a value indicating whether sorting is allowed.

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

Property Value

bool

true if sorting is allowed; otherwise, false.

AllowVirtualization

Gets or sets a value indicating whether this instance is virtualized.

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

Property Value

bool

true if this instance is virtualized; otherwise, false.

AndOperatorText

Gets or sets the and operator text.

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

Property Value

string

The and operator text.

ApplyFilterText

Gets or sets the apply filter text.

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

Property Value

string

The apply filter text.

CellClick

Gets or sets the cell click callback.

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

Property Value

EventCallback<DataGridCellMouseEventArgs<TItem>>

The cell click callback.

CellContextMenu

Gets or sets the row click callback.

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

Property Value

EventCallback<DataGridCellMouseEventArgs<TItem>>

The row click callback.

CellDoubleClick

Gets or sets the cell double click callback.

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

Property Value

EventCallback<DataGridCellMouseEventArgs<TItem>>

The cell double click callback.

CellRender

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

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

Property Value

Action<DataGridCellRenderEventArgs<TItem>>

The cell render callback.

ClearFilterText

Gets or sets the clear filter text.

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

Property Value

string

The clear filter text.

ColumnReordered

Gets or sets the column reordered callback.

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

Property Value

EventCallback<DataGridColumnReorderedEventArgs<TItem>>

The column reordered callback.

ColumnResized

Gets or sets the column resized callback.

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

Property Value

EventCallback<DataGridColumnResizedEventArgs<TItem>>

The column resized callback.

ColumnWidth

Gets or sets the width of all columns.

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

Property Value

string

The width of the columns.

Columns

Gets or sets the columns.

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

Property Value

RenderFragment

The columns.

ColumnsCollection

Gets the columns collection.

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

Property Value

IList<RadzenDataGridColumn<TItem>>

The columns collection.

ColumnsPickerAllowFiltering

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

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

Property Value

bool

true if user can filter columns in column picker; otherwise, false.

ColumnsPickerMaxSelectedLabels

Gets or sets the column picker max selected labels.

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

Property Value

int

The column picker max selected labels.

ColumnsShowingText

Gets or sets the column picker columns showing text.

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

Property Value

string

The column picker columns showing text.

ColumnsText

Gets or sets the column picker columns text.

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

Property Value

string

The column picker columns text.

ContainsText

Gets or sets the contains text.

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

Property Value

string

The contains text.

DoesNotContainText

Gets or sets the does not contain text.

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

Property Value

string

The does not contain text.

EditMode

Gets or sets the edit mode.

[Parameter]
public DataGridEditMode EditMode { get; set; }

Property Value

DataGridEditMode

The edit mode.

EditTemplate

Gets or sets the edit template.

[Parameter]
public RenderFragment<TItem> EditTemplate { get; set; }

Property Value

RenderFragment<TItem>

The template.

EmptyTemplate

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

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

Property Value

RenderFragment

The empty template.

EmptyText

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

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

Property Value

string

The empty text.

EndsWithText

Gets or sets the ends with text.

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

Property Value

string

The ends with text.

EnumFilterSelectText

Gets or sets the enum filter select text.

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

Property Value

string

The enum filter select text.

EnumFilterTranslationFunc

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

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

Property Value

Func<string, string>

EnumNullFilterText

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

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

Property Value

string

The enum filter select text.

EqualsText

Gets or sets the equals text.

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

Property Value

string

The equals text.

ExpandChildItemAriaLabel

Gets or sets the expand child item aria label text.

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

Property Value

string

The expand child item aria label text.

ExpandGroupAriaLabel

Gets or sets the expand group aria label text.

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

Property Value

string

The expand group aria label text.

ExpandMode

Gets or sets the expand mode.

[Parameter]
public DataGridExpandMode ExpandMode { get; set; }

Property Value

DataGridExpandMode

The expand mode.

Filter

Gets or sets the column filter callback.

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

Property Value

EventCallback<DataGridColumnFilterEventArgs<TItem>>

The column filter callback.

FilterCaseSensitivity

Gets or sets the filter case sensitivity.

[Parameter]
public FilterCaseSensitivity FilterCaseSensitivity { get; set; }

Property Value

FilterCaseSensitivity

The filter case sensitivity.

FilterCleared

Gets or sets the column filter cleared callback.

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

Property Value

EventCallback<DataGridColumnFilterEventArgs<TItem>>

The column filter callback.

FilterDateFormat

Gets or sets the filter date format.

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

Property Value

string

The filter date format.

FilterDelay

Gets or sets the filter delay.

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

Property Value

int

The filter delay.

FilterIcon

Gets or set the filter icon to use.

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

Property Value

string

FilterMode

Gets or sets the filter mode.

[Parameter]
public FilterMode FilterMode { get; set; }

Property Value

FilterMode

The filter mode.

FilterOperatorArialLabel

Gets or sets the column filter value aria label text.

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

Property Value

string

The the column filter value aria label text.

FilterPopupRenderMode

Gets or sets the render mode.

[Parameter]
public PopupRenderMode FilterPopupRenderMode { get; set; }

Property Value

PopupRenderMode

The render mode.

FilterText

Gets or sets the filter text.

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

Property Value

string

The filter text.

FilterToggleAriaLabel

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

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

Property Value

string

The date simple filter toggle aria label text.

FilterValueArialLabel

Gets or sets the column filter value aria label text.

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

Property Value

string

The the column filter value aria label text.

FooterCellRender

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

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

Property Value

Action<DataGridCellRenderEventArgs<TItem>>

The cell render callback.

FooterTemplate

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

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

Property Value

RenderFragment

GotoFirstPageOnSort

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

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

Property Value

bool

GreaterThanOrEqualsText

Gets or sets the greater than or equals text.

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

Property Value

string

The greater than or equals text.

GreaterThanText

Gets or sets the greater than text.

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

Property Value

string

The greater than text.

GridLines

Gets or sets the grid lines.

[Parameter]
public DataGridGridLines GridLines { get; set; }

Property Value

DataGridGridLines

The grid lines.

Group

Gets or sets the column group callback.

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

Property Value

EventCallback<DataGridColumnGroupEventArgs<TItem>>

The column group callback.

GroupFootersAlwaysVisible

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

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

Property Value

bool

true if group footers are visible when the group is collapsed otherwise, false.

GroupHeaderTemplate

Gets or sets the group header template.

[Parameter]
public RenderFragment<Group> GroupHeaderTemplate { get; set; }

Property Value

RenderFragment<Group>

The group header template.

GroupHeaderToggleTemplate

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

[Parameter]
public RenderFragment<(Group Group, RadzenDataGridGroupRow<TItem> GroupHeader)> GroupHeaderToggleTemplate { get; set; }

Property Value

RenderFragment<(Group Group, RadzenDataGridGroupRow<TItem> GroupHeader)>

The group header template with option to add custom toggle visibility.

GroupPanelText

Gets or sets the group panel text.

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

Property Value

string

The group panel text.

GroupRowCollapse

Gets or sets the group row collapse callback.

[Parameter]
public EventCallback<Group> GroupRowCollapse { get; set; }

Property Value

EventCallback<Group>

The group row collapse callback.

GroupRowExpand

Gets or sets the group row expand callback.

[Parameter]
public EventCallback<Group> GroupRowExpand { get; set; }

Property Value

EventCallback<Group>

The group row expand callback.

GroupRowRender

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

[Parameter]
public Action<GroupRowRenderEventArgs> GroupRowRender { get; set; }

Property Value

Action<GroupRowRenderEventArgs>

The group row render callback.

GroupedPagedView

Gets the view grouped and paged.

public IEnumerable<GroupResult> GroupedPagedView { get; }

Property Value

IEnumerable<GroupResult>

The grouped paged view.

Groups

Gets or sets the group descriptors.

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

Property Value

ObservableCollection<GroupDescriptor>

The groups.

HeaderCellRender

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

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

Property Value

Action<DataGridCellRenderEventArgs<TItem>>

The cell render callback.

HeaderTemplate

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

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

Property Value

RenderFragment

HideGroupedColumn

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

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

Property Value

bool

true if grouped columns should be hidden; otherwise, false.

IsEmptyText

Gets or sets the is empty text.

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

Property Value

string

The empty text.

IsLoading

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

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

Property Value

bool

true if this instance loading indicator is shown; otherwise, false.

IsNotEmptyText

Gets or sets the is not empty text.

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

Property Value

string

The not empty text.

IsNotNullText

Gets or sets the not null text.

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

Property Value

string

The not null text.

IsNullText

Gets or sets the is null text.

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

Property Value

string

The null text.

KeyProperty

Gets or sets the key property.

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

Property Value

string

The key property.

LessThanOrEqualsText

Gets or sets the less than or equals text.

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

Property Value

string

The less than or equals text.

LessThanText

Gets or sets the less than text.

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

Property Value

string

The less than text.

LoadChildData

Gets or sets the load child data callback.

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

Property Value

EventCallback<DataGridLoadChildDataEventArgs<TItem>>

The load child data callback.

LoadColumnFilterData

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

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

Property Value

EventCallback<DataGridLoadColumnFilterDataEventArgs<TItem>>

The load filter data event callback.

LoadSettings

Gets or sets the load settings callback.

[Parameter]
public Action<DataGridLoadSettingsEventArgs> LoadSettings { get; set; }

Property Value

Action<DataGridLoadSettingsEventArgs>

The load settings callback.

LogicalFilterOperator

Gets or sets the logical filter operator.

[Parameter]
public LogicalFilterOperator LogicalFilterOperator { get; set; }

Property Value

LogicalFilterOperator

The logical filter operator.

LogicalOperatorArialLabel

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

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

Property Value

string

The the column logical filter value aria label text.

NotEqualsText

Gets or sets the not equals text.

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

Property Value

string

The not equals text.

OrOperatorText

Gets or sets the or operator text.

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

Property Value

string

The or operator text.

PageSizeChanged

Gets or sets the page size changed callback.

[Parameter]
public EventCallback<int> PageSizeChanged { get; set; }

Property Value

EventCallback<int>

The page size changed callback.

PickedColumnsChanged

Gets or sets the picked columns changed callback.

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

Property Value

EventCallback<DataGridPickedColumnsChangedEventArgs<TItem>>

The picked columns changed callback.

Query

Gets the query.

public Query Query { get; }

Property Value

Query

The query.

RemoveGroupArialLabel

Gets or sets the remove group button aria label text.

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

Property Value

string

The remove group button aria label text.

Render

Gets or sets the render callback.

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

Property Value

Action<DataGridRenderEventArgs<TItem>>

The render callback.

RenderAsync

Gets or sets the render async callback.

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

Property Value

Func<DataGridRenderEventArgs<TItem>, Task>

The render async callback.

Responsive

Gets or sets a value indicating whether DataGrid is responsive.

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

Property Value

bool

true if DataGrid is Responsive; otherwise, false.

RowClick

Gets or sets the row click callback.

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

Property Value

EventCallback<DataGridRowMouseEventArgs<TItem>>

The row click callback.

RowCollapse

Gets or sets the row collapse callback.

[Parameter]
public EventCallback<TItem> RowCollapse { get; set; }

Property Value

EventCallback<TItem>

The row collapse callback.

RowCreate

Gets or sets the row create callback.

[Parameter]
public EventCallback<TItem> RowCreate { get; set; }

Property Value

EventCallback<TItem>

The row create callback.

RowDeselect

Gets or sets the row deselect callback.

[Parameter]
public EventCallback<TItem> RowDeselect { get; set; }

Property Value

EventCallback<TItem>

The row deselect callback.

RowDoubleClick

Gets or sets the row double click callback.

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

Property Value

EventCallback<DataGridRowMouseEventArgs<TItem>>

The row double click callback.

RowEdit

Gets or sets the row edit callback.

[Parameter]
public EventCallback<TItem> RowEdit { get; set; }

Property Value

EventCallback<TItem>

The row edit callback.

RowExpand

Gets or sets the row expand callback.

[Parameter]
public EventCallback<TItem> RowExpand { get; set; }

Property Value

EventCallback<TItem>

The row expand callback.

RowRender

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

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

Property Value

Action<RowRenderEventArgs<TItem>>

The row render callback.

RowSelect

Gets or sets the row select callback.

[Parameter]
public EventCallback<TItem> RowSelect { get; set; }

Property Value

EventCallback<TItem>

The row select callback.

RowUpdate

Gets or sets the row update callback.

[Parameter]
public EventCallback<TItem> RowUpdate { get; set; }

Property Value

EventCallback<TItem>

The row update callback.

SecondFilterOperatorArialLabel

Gets or sets the column filter value aria label text.

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

Property Value

string

The the column filter value aria label text.

SecondFilterValueArialLabel

Gets or sets the column filter value aria label text.

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

Property Value

string

The the column filter value aria label text.

SelectVisibleColumnsArialLabel

Gets or sets the select visible columns aria label text.

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

Property Value

string

The select visible columns aria label text.

SelectionMode

Gets or sets the selection mode.

[Parameter]
public DataGridSelectionMode SelectionMode { get; set; }

Property Value

DataGridSelectionMode

The selection mode.

Settings

Gets or sets DataGrid settings.

[Parameter]
public DataGridSettings Settings { get; set; }

Property Value

DataGridSettings

SettingsChanged

Gets or sets the settings changed callback.

[Parameter]
public EventCallback<DataGridSettings> SettingsChanged { get; set; }

Property Value

EventCallback<DataGridSettings>

The settings callback.

ShowCellDataAsTooltip

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

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

Property Value

bool

true if cell data is shown as tooltip; otherwise, false.

ShowColumnTitleAsTooltip

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

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

Property Value

bool

true if column title is shown as tooltip; otherwise, false.

ShowEmptyMessage

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

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

Property Value

bool

ShowExpandColumn

Gets or sets whether the expandable indicator column is visible.

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

Property Value

bool

The expandable indicator column visibility.

ShowGroupExpandColumn

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

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

Property Value

bool

true if want to show left column with group visibility toggle, otherwise false.

ShowMultiColumnSortingIndex

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

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

Property Value

bool

true if multi column sorting index is shown; otherwise, false.

Sort

Gets or sets the column sort callback.

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

Property Value

EventCallback<DataGridColumnSortEventArgs<TItem>>

The column sort callback.

Sorts

Gets or sets the sort descriptors.

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

Property Value

ObservableCollection<SortDescriptor>

The sort.

StartsWithText

Gets or sets the starts with text.

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

Property Value

string

The starts with text.

Value

Gets or sets the selected item.

[Parameter]
public IList<TItem> Value { get; set; }

Property Value

IList<TItem>

The selected item.

ValueChanged

Gets or sets the value changed callback.

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

Property Value

EventCallback<IList<TItem>>

The value changed callback.

View

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

public override IQueryable<TItem> View { get; }

Property Value

IQueryable<TItem>

The view.

VirtualizationOverscanCount

Gets or sets a value that determines how many additional items will be rendered before and after the visible region. This help to reduce the frequency of rendering during scrolling. However, higher values mean that more elements will be present in the page.

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

Property Value

int

Virtualize

Gets Virtualize component reference.

public Virtualize<TItem> Virtualize { get; }

Property Value

Virtualize<TItem>

Methods

ApplyDateFilterByFilterOperator(RadzenDataGridColumn<TItem>, FilterOperator)

Applies the date filter by filter operator.

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

Parameters

column RadzenDataGridColumn<TItem>

The column.

filterOperator FilterOperator

The filter operator.

ApplyFilter(RadzenDataGridColumn<TItem>, bool)

Apply filter to the specified column

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

Parameters

column RadzenDataGridColumn<TItem>
closePopup bool

Returns

Task

BuildRenderTree(RenderTreeBuilder) 

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

__builder RenderTreeBuilder

CancelEditRow(TItem)

Cancels the edited row.

public void CancelEditRow(TItem item)

Parameters

item TItem

The item.

CancelEditRows(IEnumerable<TItem>)

Cancels the edit of a range of rows.

public void CancelEditRows(IEnumerable<TItem> items)

Parameters

items IEnumerable<TItem>

The range of rows.

ClearFilter(RadzenDataGridColumn<TItem>, bool, bool)

Сlear filter on the specified column

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

Parameters

column RadzenDataGridColumn<TItem>
closePopup bool
shouldReload bool

Returns

Task

CollapseAll()

Collapse all rows that are expanded

public Task CollapseAll()

Returns

Task

CollapseRows(IEnumerable<TItem>)

Collapse a range of rows.

public Task CollapseRows(IEnumerable<TItem> items)

Parameters

items IEnumerable<TItem>

The range of rows.

Returns

Task

DateFilterOperatorStyle(RadzenDataGridColumn<TItem>, FilterOperator)

The filter operator style for dates.

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

Parameters

column RadzenDataGridColumn<TItem>

The column.

value FilterOperator

The value.

Returns

string

System.String.

Dispose() 

public override void Dispose()

EditRow(TItem)

Edits the row.

public Task EditRow(TItem item)

Parameters

item TItem

The item.

Returns

Task

EditRows(IEnumerable<TItem>)

Edits a range of rows.

public Task EditRows(IEnumerable<TItem> items)

Parameters

items IEnumerable<TItem>

The range of rows.

Returns

Task

ExpandGroupItem(RadzenDataGridGroupRow<TItem>, bool?)

Expand group item.

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

Parameters

item RadzenDataGridGroupRow<TItem>
expandedOnLoad bool?

Returns

Task

ExpandRow(TItem)

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

public Task ExpandRow(TItem item)

Parameters

item TItem

The item.

Returns

Task

ExpandRows(IEnumerable<TItem>)

Expands a range of rows.

public Task ExpandRows(IEnumerable<TItem> items)

Parameters

items IEnumerable<TItem>

The range of rows.

Returns

Task

GetComponentCssClass() 

protected override string GetComponentCssClass()

Returns

string

InsertRow(TItem)

Inserts new row.

public Task InsertRow(TItem item)

Parameters

item TItem

The item.

Returns

Task

IsRowExpanded(TItem)

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

public bool IsRowExpanded(TItem item)

Parameters

item TItem

The item.

Returns

bool

IsRowInEditMode(TItem)

Determines whether row in edit mode.

public bool IsRowInEditMode(TItem item)

Parameters

item TItem

The item.

Returns

bool

true if row in edit mode; otherwise, false.

ItemEquals(TItem, TItem)

Compares two items

protected bool ItemEquals(TItem item, TItem otherItem)

Parameters

item TItem

The first item

otherItem TItem

The second item

Returns

bool

Are items equal

OnAfterRenderAsync(bool) 

protected override Task OnAfterRenderAsync(bool firstRender)

Parameters

firstRender bool

Returns

Task

OnCollectionChanged(object, NotifyCollectionChangedEventArgs) 

protected override void OnCollectionChanged(object sender, NotifyCollectionChangedEventArgs args)

Parameters

sender object
args NotifyCollectionChangedEventArgs

OnColumnResized(int, double)

Called when column is resized.

[JSInvokable("RadzenGrid.OnColumnResized")]
public Task OnColumnResized(int columnIndex, double value)

Parameters

columnIndex int

Index of the column.

value double

The value.

Returns

Task

OnDataChanged()

Called when data is changed.

protected override void OnDataChanged()

OnFilter(ChangeEventArgs, RadzenDataGridColumn<TItem>, bool, bool)

Called when filter.

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

Parameters

args ChangeEventArgs

The ChangeEventArgs instance containing the event data.

column RadzenDataGridColumn<TItem>

The column.

force bool

if set to true [force].

isFirst bool

if set to true [is first].

Returns

Task

OnFilterKeyPress(EventArgs, RadzenDataGridColumn<TItem>)

Called when filter key pressed.

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

Parameters

args EventArgs

The EventArgs instance containing the event data.

column RadzenDataGridColumn<TItem>

The column.

OnKeyDown(KeyboardEventArgs)

Handles the KeyDown event.

protected virtual Task OnKeyDown(KeyboardEventArgs args)

Parameters

args KeyboardEventArgs

The KeyboardEventArgs instance containing the event data.

Returns

Task

OnPageSizeChanged(int) 

protected override Task OnPageSizeChanged(int value)

Parameters

value int

Returns

Task

OnParametersSetAsync()

Called when parameters set asynchronous.

protected override Task OnParametersSetAsync()

Returns

Task

Task.

OrderBy(string)

Orders the DataGrid by property name.

public void OrderBy(string property)

Parameters

property string

The property name.

OrderByDescending(string)

Orders descending the DataGrid by property name.

public void OrderByDescending(string property)

Parameters

property string

The property name.

RefreshDataAsync()

Clears the cache and refreshes the Virtualize component.

public Task RefreshDataAsync()

Returns

Task

Reload()

Reloads this instance.

public override Task Reload()

Returns

Task

Reset(bool, bool)

Resets the DataGrid instance to initial state with no sorting, grouping and/or filtering, column visibility.

public void Reset(bool resetColumnState = true, bool resetRowState = false)

Parameters

resetColumnState bool

if set to true [reset column state].

resetRowState bool

if set to true [reset row state].

ResetLoadData()

Reset the LoadData internal state

public void ResetLoadData()

SelectRow(TItem, bool)

Selects the row.

public Task SelectRow(TItem item, bool raiseEvent = true)

Parameters

item TItem

The item.

raiseEvent bool

Should raise RowSelect event.

Returns

Task

SetParametersAsync(ParameterView) 

public override Task SetParametersAsync(ParameterView parameters)

Parameters

parameters ParameterView

Returns

Task

UpdatePickableColumns()

Updates pickable columns.

public void UpdatePickableColumns()

UpdateRow(TItem)

Updates the row.

public Task UpdateRow(TItem item)

Parameters

item TItem

The item.

Returns

Task