Class RadzenDataGrid<TItem>
RadzenDataGrid component.
Implements
Inherited Members
Namespace: Radzen.Blazor
Assembly: Radzen.Blazor.dll
Syntax
public class RadzenDataGrid<TItem> : PagedDataBoundComponent<TItem>, IDisposable
Type Parameters
Name | Description |
---|---|
TItem | The type of the DataGrid data item. |
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>
Properties
AllColumnsText
Gets or sets the column picker all columns text.
Declaration
public string AllColumnsText { get; set; }
Property Value
Type | Description |
---|---|
System.String | The column picker all columns text. |
AllGroupsExpanded
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 |
---|---|
System.Nullable<System.Boolean> |
|
AllGroupsExpandedChanged
Gets or sets the AllGroupsExpanded changed callback.
Declaration
public EventCallback<bool?> AllGroupsExpandedChanged { get; set; }
Property Value
Type | Description |
---|---|
EventCallback<System.Nullable<System.Boolean>> | The AllGroupsExpanded changed callback. |
AllowAlternatingRows
Gets or sets a value indicating whether DataGrid should use alternating row styles.
Declaration
public bool AllowAlternatingRows { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
|
AllowColumnPicking
Gets or sets a value indicating whether column picking is allowed.
Declaration
public bool AllowColumnPicking { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
|
AllowColumnReorder
Gets or sets a value indicating whether column reorder is allowed.
Declaration
public bool AllowColumnReorder { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
|
AllowColumnResize
Gets or sets a value indicating whether column resizing is allowed.
Declaration
public bool AllowColumnResize { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
|
AllowCompositeDataCells
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 |
---|---|
System.Boolean |
|
AllowFilterDateInput
Gets or sets a value indicating whether input is allowed in filter DatePicker.
Declaration
public bool AllowFilterDateInput { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
|
AllowFiltering
Gets or sets a value indicating whether filtering is allowed.
Declaration
public bool AllowFiltering { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
|
AllowGrouping
Gets or sets a value indicating whether grouping is allowed.
Declaration
public bool AllowGrouping { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
|
AllowMultiColumnSorting
Gets or sets a value indicating whether multi column sorting is allowed.
Declaration
public bool AllowMultiColumnSorting { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
|
AllowPickAllColumns
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 |
---|---|
System.Boolean |
|
AllowRowSelectOnRowClick
Gets or sets a value indicating whether DataGrid row can be selected on row click.
Declaration
public bool AllowRowSelectOnRowClick { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
|
AllowSorting
Gets or sets a value indicating whether sorting is allowed.
Declaration
public bool AllowSorting { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
|
AndOperatorText
Gets or sets the and operator text.
Declaration
public string AndOperatorText { get; set; }
Property Value
Type | Description |
---|---|
System.String | The and operator text. |
ApplyFilterText
Gets or sets the apply filter text.
Declaration
public string ApplyFilterText { get; set; }
Property Value
Type | Description |
---|---|
System.String | The apply filter text. |
CellClick
Gets or sets the cell click callback.
Declaration
public EventCallback<DataGridCellMouseEventArgs<TItem>> CellClick { get; set; }
Property Value
Type | Description |
---|---|
EventCallback<DataGridCellMouseEventArgs<TItem>> | The cell click callback. |
CellContextMenu
Gets or sets the row click callback.
Declaration
public EventCallback<DataGridCellMouseEventArgs<TItem>> CellContextMenu { get; set; }
Property Value
Type | Description |
---|---|
EventCallback<DataGridCellMouseEventArgs<TItem>> | The row click callback. |
CellDoubleClick
Gets or sets the cell double click callback.
Declaration
public EventCallback<DataGridCellMouseEventArgs<TItem>> CellDoubleClick { get; set; }
Property Value
Type | Description |
---|---|
EventCallback<DataGridCellMouseEventArgs<TItem>> | The cell double click callback. |
CellRender
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>> | The cell render callback. |
ClearFilterText
Gets or sets the clear filter text.
Declaration
public string ClearFilterText { get; set; }
Property Value
Type | Description |
---|---|
System.String | The clear filter text. |
ColumnReordered
Gets or sets the column reordered callback.
Declaration
public EventCallback<DataGridColumnReorderedEventArgs<TItem>> ColumnReordered { get; set; }
Property Value
Type | Description |
---|---|
EventCallback<DataGridColumnReorderedEventArgs<TItem>> | The column reordered callback. |
ColumnResized
Gets or sets the column resized callback.
Declaration
public EventCallback<DataGridColumnResizedEventArgs<TItem>> ColumnResized { get; set; }
Property Value
Type | Description |
---|---|
EventCallback<DataGridColumnResizedEventArgs<TItem>> | The column resized callback. |
Columns
Gets or sets the columns.
Declaration
public RenderFragment Columns { get; set; }
Property Value
Type | Description |
---|---|
RenderFragment | The columns. |
ColumnsCollection
Gets the columns collection.
Declaration
public IList<RadzenDataGridColumn<TItem>> ColumnsCollection { get; }
Property Value
Type | Description |
---|---|
IList<RadzenDataGridColumn<TItem>> | The columns collection. |
ColumnsPickerAllowFiltering
Gets or sets a value indicating whether user can filter columns in column picker.
Declaration
public bool ColumnsPickerAllowFiltering { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
|
ColumnsPickerMaxSelectedLabels
Gets or sets the column picker max selected labels.
Declaration
public int ColumnsPickerMaxSelectedLabels { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 | The column picker max selected labels. |
ColumnsShowingText
Gets or sets the column picker columns showing text.
Declaration
public string ColumnsShowingText { get; set; }
Property Value
Type | Description |
---|---|
System.String | The column picker columns showing text. |
ColumnsText
Gets or sets the column picker columns text.
Declaration
public string ColumnsText { get; set; }
Property Value
Type | Description |
---|---|
System.String | The column picker columns text. |
ColumnWidth
Gets or sets the width of all columns.
Declaration
public string ColumnWidth { get; set; }
Property Value
Type | Description |
---|---|
System.String | The width of the columns. |
ContainsText
Gets or sets the contains text.
Declaration
public string ContainsText { get; set; }
Property Value
Type | Description |
---|---|
System.String | The contains text. |
DoesNotContainText
Gets or sets the does not contain text.
Declaration
public string DoesNotContainText { get; set; }
Property Value
Type | Description |
---|---|
System.String | The does not contain text. |
EditMode
Gets or sets the edit mode.
Declaration
public DataGridEditMode EditMode { get; set; }
Property Value
Type | Description |
---|---|
DataGridEditMode | The edit mode. |
EditTemplate
Gets or sets the edit template.
Declaration
public RenderFragment<TItem> EditTemplate { get; set; }
Property Value
Type | Description |
---|---|
RenderFragment<TItem> | The template. |
EmptyTemplate
Gets or sets the empty template shown when Data is empty collection.
Declaration
public RenderFragment EmptyTemplate { get; set; }
Property Value
Type | Description |
---|---|
RenderFragment | The empty template. |
EmptyText
Gets or sets the empty text shown when Data is empty collection.
Declaration
public string EmptyText { get; set; }
Property Value
Type | Description |
---|---|
System.String | The empty text. |
EndsWithText
Gets or sets the ends with text.
Declaration
public string EndsWithText { get; set; }
Property Value
Type | Description |
---|---|
System.String | The ends with text. |
EnumFilterSelectText
Gets or sets the enum filter select text.
Declaration
public string EnumFilterSelectText { get; set; }
Property Value
Type | Description |
---|---|
System.String | The enum filter select text. |
EnumFilterTranslationFunc
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<System.String, System.String> |
EnumNullFilterText
Gets or sets the nullable enum for null value filter text.
Declaration
public string EnumNullFilterText { get; set; }
Property Value
Type | Description |
---|---|
System.String | The enum filter select text. |
EqualsText
Gets or sets the equals text.
Declaration
public string EqualsText { get; set; }
Property Value
Type | Description |
---|---|
System.String | The equals text. |
ExpandChildItemAriaLabel
Gets or sets the expand child item aria label text.
Declaration
public string ExpandChildItemAriaLabel { get; set; }
Property Value
Type | Description |
---|---|
System.String | The expand child item aria label text. |
ExpandGroupAriaLabel
Gets or sets the expand group aria label text.
Declaration
public string ExpandGroupAriaLabel { get; set; }
Property Value
Type | Description |
---|---|
System.String | The expand group aria label text. |
ExpandMode
Gets or sets the expand mode.
Declaration
public DataGridExpandMode ExpandMode { get; set; }
Property Value
Type | Description |
---|---|
DataGridExpandMode | The expand mode. |
Filter
Gets or sets the column filter callback.
Declaration
public EventCallback<DataGridColumnFilterEventArgs<TItem>> Filter { get; set; }
Property Value
Type | Description |
---|---|
EventCallback<DataGridColumnFilterEventArgs<TItem>> | The column filter callback. |
FilterCaseSensitivity
Gets or sets the filter case sensitivity.
Declaration
public FilterCaseSensitivity FilterCaseSensitivity { get; set; }
Property Value
Type | Description |
---|---|
FilterCaseSensitivity | The filter case sensitivity. |
FilterCleared
Gets or sets the column filter cleared callback.
Declaration
public EventCallback<DataGridColumnFilterEventArgs<TItem>> FilterCleared { get; set; }
Property Value
Type | Description |
---|---|
EventCallback<DataGridColumnFilterEventArgs<TItem>> | The column filter callback. |
FilterDateFormat
Gets or sets the filter date format.
Declaration
public string FilterDateFormat { get; set; }
Property Value
Type | Description |
---|---|
System.String | The filter date format. |
FilterDelay
Gets or sets the filter delay.
Declaration
public int FilterDelay { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 | The filter delay. |
FilterIcon
Gets or set the filter icon to use.
Declaration
public string FilterIcon { get; set; }
Property Value
Type | Description |
---|---|
System.String |
FilterMode
Gets or sets the filter mode.
Declaration
public FilterMode FilterMode { get; set; }
Property Value
Type | Description |
---|---|
FilterMode | The filter mode. |
FilterOperatorArialLabel
Gets or sets the column filter value aria label text.
Declaration
public string FilterOperatorArialLabel { get; set; }
Property Value
Type | Description |
---|---|
System.String | The the column filter value aria label text. |
FilterPopupRenderMode
Gets or sets the render mode.
Declaration
public PopupRenderMode FilterPopupRenderMode { get; set; }
Property Value
Type | Description |
---|---|
PopupRenderMode | The render mode. |
FilterText
Gets or sets the filter text.
Declaration
public string FilterText { get; set; }
Property Value
Type | Description |
---|---|
System.String | The filter text. |
FilterValueArialLabel
Gets or sets the column filter value aria label text.
Declaration
public string FilterValueArialLabel { get; set; }
Property Value
Type | Description |
---|---|
System.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.
Declaration
public Action<DataGridCellRenderEventArgs<TItem>> FooterCellRender { get; set; }
Property Value
Type | Description |
---|---|
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
Declaration
public RenderFragment FooterTemplate { get; set; }
Property Value
Type | Description |
---|---|
RenderFragment |
GotoFirstPageOnSort
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 |
---|---|
System.Boolean |
GreaterThanOrEqualsText
Gets or sets the greater than or equals text.
Declaration
public string GreaterThanOrEqualsText { get; set; }
Property Value
Type | Description |
---|---|
System.String | The greater than or equals text. |
GreaterThanText
Gets or sets the greater than text.
Declaration
public string GreaterThanText { get; set; }
Property Value
Type | Description |
---|---|
System.String | The greater than text. |
GridLines
Gets or sets the grid lines.
Declaration
public DataGridGridLines GridLines { get; set; }
Property Value
Type | Description |
---|---|
DataGridGridLines | The grid lines. |
Group
Gets or sets the column group callback.
Declaration
public EventCallback<DataGridColumnGroupEventArgs<TItem>> Group { get; set; }
Property Value
Type | Description |
---|---|
EventCallback<DataGridColumnGroupEventArgs<TItem>> | The column group callback. |
GroupedPagedView
Gets the view grouped and paged.
Declaration
public IEnumerable<GroupResult> GroupedPagedView { get; }
Property Value
Type | Description |
---|---|
IEnumerable<GroupResult> | The grouped paged view. |
GroupFootersAlwaysVisible
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 |
---|---|
System.Boolean |
|
GroupHeaderTemplate
Gets or sets the group header template.
Declaration
public RenderFragment<Group> GroupHeaderTemplate { get; set; }
Property Value
Type | Description |
---|---|
RenderFragment<Group> | The group header template. |
GroupHeaderToggleTemplate
Gets or sets the group header with option to add custom toggle visibility button template.
Declaration
public RenderFragment<(Group Group, RadzenDataGridGroupRow<TItem> GroupHeader)> GroupHeaderToggleTemplate { get; set; }
Property Value
Type | Description |
---|---|
RenderFragment<System.ValueTuple<Group, RadzenDataGridGroupRow<TItem>>> | The group header template with option to add custom toggle visibility. |
GroupPanelText
Gets or sets the group panel text.
Declaration
public string GroupPanelText { get; set; }
Property Value
Type | Description |
---|---|
System.String | The group panel text. |
GroupRowCollapse
Gets or sets the group row collapse callback.
Declaration
public EventCallback<Group> GroupRowCollapse { get; set; }
Property Value
Type | Description |
---|---|
EventCallback<Group> | The group row collapse callback. |
GroupRowExpand
Gets or sets the group row expand callback.
Declaration
public EventCallback<Group> GroupRowExpand { get; set; }
Property Value
Type | Description |
---|---|
EventCallback<Group> | The group row expand callback. |
GroupRowRender
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> | The group row render callback. |
Groups
Gets or sets the group descriptors.
Declaration
public ObservableCollection<GroupDescriptor> Groups { get; set; }
Property Value
Type | Description |
---|---|
ObservableCollection<GroupDescriptor> | The groups. |
HeaderCellRender
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>> | 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
Declaration
public RenderFragment HeaderTemplate { get; set; }
Property Value
Type | Description |
---|---|
RenderFragment |
HideGroupedColumn
Gets or sets a value indicating whether grouped column should be hidden.
Declaration
public bool HideGroupedColumn { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
|
IsEmptyText
Gets or sets the is empty text.
Declaration
public string IsEmptyText { get; set; }
Property Value
Type | Description |
---|---|
System.String | The empty text. |
IsLoading
Gets or sets a value indicating whether this instance loading indicator is shown.
Declaration
public bool IsLoading { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
|
IsNotEmptyText
Gets or sets the is not empty text.
Declaration
public string IsNotEmptyText { get; set; }
Property Value
Type | Description |
---|---|
System.String | The not empty text. |
IsNotNullText
Gets or sets the not null text.
Declaration
public string IsNotNullText { get; set; }
Property Value
Type | Description |
---|---|
System.String | The not null text. |
IsNullText
Gets or sets the is null text.
Declaration
public string IsNullText { get; set; }
Property Value
Type | Description |
---|---|
System.String | The null text. |
KeyProperty
Gets or sets the key property.
Declaration
public string KeyProperty { get; set; }
Property Value
Type | Description |
---|---|
System.String | The key property. |
LessThanOrEqualsText
Gets or sets the less than or equals text.
Declaration
public string LessThanOrEqualsText { get; set; }
Property Value
Type | Description |
---|---|
System.String | The less than or equals text. |
LessThanText
Gets or sets the less than text.
Declaration
public string LessThanText { get; set; }
Property Value
Type | Description |
---|---|
System.String | The less than text. |
LoadChildData
Gets or sets the load child data callback.
Declaration
public EventCallback<DataGridLoadChildDataEventArgs<TItem>> LoadChildData { get; set; }
Property Value
Type | Description |
---|---|
EventCallback<DataGridLoadChildDataEventArgs<TItem>> | The load child data callback. |
LoadSettings
Gets or sets the load settings callback.
Declaration
public Action<DataGridLoadSettingsEventArgs> LoadSettings { get; set; }
Property Value
Type | Description |
---|---|
Action<DataGridLoadSettingsEventArgs> | The load settings callback. |
LogicalFilterOperator
Gets or sets the logical filter operator.
Declaration
public LogicalFilterOperator LogicalFilterOperator { get; set; }
Property Value
Type | Description |
---|---|
LogicalFilterOperator | The logical filter operator. |
LogicalOperatorArialLabel
Gets or sets the column logical filter value aria label text.
Declaration
public string LogicalOperatorArialLabel { get; set; }
Property Value
Type | Description |
---|---|
System.String | The the column logical filter value aria label text. |
NotEqualsText
Gets or sets the not equals text.
Declaration
public string NotEqualsText { get; set; }
Property Value
Type | Description |
---|---|
System.String | The not equals text. |
OrOperatorText
Gets or sets the or operator text.
Declaration
public string OrOperatorText { get; set; }
Property Value
Type | Description |
---|---|
System.String | The or operator text. |
PageSizeChanged
Gets or sets the page size changed callback.
Declaration
public EventCallback<int> PageSizeChanged { get; set; }
Property Value
Type | Description |
---|---|
EventCallback<System.Int32> | The page size changed callback. |
PickedColumnsChanged
Gets or sets the picked columns changed callback.
Declaration
public EventCallback<DataGridPickedColumnsChangedEventArgs<TItem>> PickedColumnsChanged { get; set; }
Property Value
Type | Description |
---|---|
EventCallback<DataGridPickedColumnsChangedEventArgs<TItem>> | The picked columns changed callback. |
Query
Gets the query.
Declaration
public Query Query { get; }
Property Value
Type | Description |
---|---|
Query | The query. |
RemoveGroupArialLabel
Gets or sets the remove group button aria label text.
Declaration
public string RemoveGroupArialLabel { get; set; }
Property Value
Type | Description |
---|---|
System.String | The remove group button aria label text. |
Render
Gets or sets the render callback.
Declaration
public Action<DataGridRenderEventArgs<TItem>> Render { get; set; }
Property Value
Type | Description |
---|---|
Action<DataGridRenderEventArgs<TItem>> | The render callback. |
RenderAsync
Gets or sets the render async callback.
Declaration
public Func<DataGridRenderEventArgs<TItem>, Task> RenderAsync { get; set; }
Property Value
Type | Description |
---|---|
Func<DataGridRenderEventArgs<TItem>, Task> | The render async callback. |
Responsive
Gets or sets a value indicating whether DataGrid is responsive.
Declaration
public bool Responsive { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
|
RowClick
Gets or sets the row click callback.
Declaration
public EventCallback<DataGridRowMouseEventArgs<TItem>> RowClick { get; set; }
Property Value
Type | Description |
---|---|
EventCallback<DataGridRowMouseEventArgs<TItem>> | The row click callback. |
RowCollapse
Gets or sets the row collapse callback.
Declaration
public EventCallback<TItem> RowCollapse { get; set; }
Property Value
Type | Description |
---|---|
EventCallback<TItem> | The row collapse callback. |
RowCreate
Gets or sets the row create callback.
Declaration
public EventCallback<TItem> RowCreate { get; set; }
Property Value
Type | Description |
---|---|
EventCallback<TItem> | The row create callback. |
RowDeselect
Gets or sets the row deselect callback.
Declaration
public EventCallback<TItem> RowDeselect { get; set; }
Property Value
Type | Description |
---|---|
EventCallback<TItem> | The row deselect callback. |
RowDoubleClick
Gets or sets the row double click callback.
Declaration
public EventCallback<DataGridRowMouseEventArgs<TItem>> RowDoubleClick { get; set; }
Property Value
Type | Description |
---|---|
EventCallback<DataGridRowMouseEventArgs<TItem>> | The row double click callback. |
RowEdit
Gets or sets the row edit callback.
Declaration
public EventCallback<TItem> RowEdit { get; set; }
Property Value
Type | Description |
---|---|
EventCallback<TItem> | The row edit callback. |
RowExpand
Gets or sets the row expand callback.
Declaration
public EventCallback<TItem> RowExpand { get; set; }
Property Value
Type | Description |
---|---|
EventCallback<TItem> | The row expand callback. |
RowRender
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>> | The row render callback. |
RowSelect
Gets or sets the row select callback.
Declaration
public EventCallback<TItem> RowSelect { get; set; }
Property Value
Type | Description |
---|---|
EventCallback<TItem> | The row select callback. |
RowUpdate
Gets or sets the row update callback.
Declaration
public EventCallback<TItem> RowUpdate { get; set; }
Property Value
Type | Description |
---|---|
EventCallback<TItem> | The row update callback. |
SecondFilterOperatorArialLabel
Gets or sets the column filter value aria label text.
Declaration
public string SecondFilterOperatorArialLabel { get; set; }
Property Value
Type | Description |
---|---|
System.String | The the column filter value aria label text. |
SecondFilterValueArialLabel
Gets or sets the column filter value aria label text.
Declaration
public string SecondFilterValueArialLabel { get; set; }
Property Value
Type | Description |
---|---|
System.String | The the column filter value aria label text. |
SelectionMode
Gets or sets the selection mode.
Declaration
public DataGridSelectionMode SelectionMode { get; set; }
Property Value
Type | Description |
---|---|
DataGridSelectionMode | The selection mode. |
SelectVisibleColumnsArialLabel
Gets or sets the select visible columns aria label text.
Declaration
public string SelectVisibleColumnsArialLabel { get; set; }
Property Value
Type | Description |
---|---|
System.String | The select visible columns aria label text. |
Settings
Gets or sets DataGrid settings.
Declaration
public DataGridSettings Settings { get; set; }
Property Value
Type | Description |
---|---|
DataGridSettings |
SettingsChanged
Gets or sets the settings changed callback.
Declaration
public EventCallback<DataGridSettings> SettingsChanged { get; set; }
Property Value
Type | Description |
---|---|
EventCallback<DataGridSettings> | The settings callback. |
ShowCellDataAsTooltip
Gets or sets a value indicating whether cell data should be shown as tooltip.
Declaration
public bool ShowCellDataAsTooltip { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
|
ShowColumnTitleAsTooltip
Gets or sets a value indicating whether column title should be shown as tooltip.
Declaration
public bool ShowColumnTitleAsTooltip { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
|
ShowEmptyMessage
Gets or sets a value indicating whether DataGrid data body show empty message.
Declaration
public bool ShowEmptyMessage { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
ShowExpandColumn
Gets or sets whether the expandable indicator column is visible.
Declaration
public bool ShowExpandColumn { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The expandable indicator column visibility. |
ShowGroupExpandColumn
Gets or sets a value indicating whether to show group visibility column
Declaration
public bool ShowGroupExpandColumn { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
|
ShowMultiColumnSortingIndex
Gets or sets a value indicating whether multi column sorting index is shown.
Declaration
public bool ShowMultiColumnSortingIndex { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
|
Sort
Gets or sets the column sort callback.
Declaration
public EventCallback<DataGridColumnSortEventArgs<TItem>> Sort { get; set; }
Property Value
Type | Description |
---|---|
EventCallback<DataGridColumnSortEventArgs<TItem>> | The column sort callback. |
Sorts
Gets or sets the sort descriptors.
Declaration
public ObservableCollection<SortDescriptor> Sorts { get; set; }
Property Value
Type | Description |
---|---|
ObservableCollection<SortDescriptor> | The sort. |
StartsWithText
Gets or sets the starts with text.
Declaration
public string StartsWithText { get; set; }
Property Value
Type | Description |
---|---|
System.String | The starts with text. |
Value
Gets or sets the selected item.
Declaration
public IList<TItem> Value { get; set; }
Property Value
Type | Description |
---|---|
IList<TItem> | The selected item. |
ValueChanged
Gets or sets the value changed callback.
Declaration
public EventCallback<IList<TItem>> ValueChanged { get; set; }
Property Value
Type | Description |
---|---|
EventCallback<IList<TItem>> | The value changed callback. |
View
Gets the view - Data with sorting, filtering and paging applied.
Declaration
public override IQueryable<TItem> View { get; }
Property Value
Type | Description |
---|---|
IQueryable<TItem> | The view. |
Overrides
Methods
ApplyDateFilterByFilterOperator(RadzenDataGridColumn<TItem>, FilterOperator)
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. |
ApplyFilter(RadzenDataGridColumn<TItem>, Boolean)
Apply filter to the specified column
Declaration
public async Task ApplyFilter(RadzenDataGridColumn<TItem> column, bool closePopup = false)
Parameters
Type | Name | Description |
---|---|---|
RadzenDataGridColumn<TItem> | column | |
System.Boolean | closePopup |
Returns
Type | Description |
---|---|
Task |
CancelEditRow(TItem)
Cancels the edited row.
Declaration
public void CancelEditRow(TItem item)
Parameters
Type | Name | Description |
---|---|---|
TItem | item | The item. |
CancelEditRows(IEnumerable<TItem>)
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. |
ClearFilter(RadzenDataGridColumn<TItem>, Boolean, Boolean)
Сlear filter on the specified column
Declaration
public async Task ClearFilter(RadzenDataGridColumn<TItem> column, bool closePopup = false, bool shouldReload = true)
Parameters
Type | Name | Description |
---|---|---|
RadzenDataGridColumn<TItem> | column | |
System.Boolean | closePopup | |
System.Boolean | shouldReload |
Returns
Type | Description |
---|---|
Task |
CollapseAll()
Collapse all rows that are expanded
Declaration
public async System.Threading.Tasks.Task CollapseAll()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task |
CollapseRows(IEnumerable<TItem>)
Collapse a range of rows.
Declaration
public async System.Threading.Tasks.Task CollapseRows(IEnumerable<TItem> items)
Parameters
Type | Name | Description |
---|---|---|
IEnumerable<TItem> | items | The range of rows. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task |
DateFilterOperatorStyle(RadzenDataGridColumn<TItem>, FilterOperator)
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 |
---|---|
System.String | System.String. |
Dispose()
Detaches event handlers and disposes Reference.
Declaration
public override void Dispose()
Overrides
EditRow(TItem)
Edits the row.
Declaration
public async System.Threading.Tasks.Task EditRow(TItem item)
Parameters
Type | Name | Description |
---|---|---|
TItem | item | The item. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task |
EditRows(IEnumerable<TItem>)
Edits a range of rows.
Declaration
public async System.Threading.Tasks.Task EditRows(IEnumerable<TItem> items)
Parameters
Type | Name | Description |
---|---|---|
IEnumerable<TItem> | items | The range of rows. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task |
ExpandGroupItem(RadzenDataGridGroupRow<TItem>, Nullable<Boolean>)
Expand group item.
Declaration
public async System.Threading.Tasks.Task ExpandGroupItem(RadzenDataGridGroupRow<TItem> item, bool? expandedOnLoad)
Parameters
Type | Name | Description |
---|---|---|
RadzenDataGridGroupRow<TItem> | item | |
System.Nullable<System.Boolean> | expandedOnLoad |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task |
ExpandRow(TItem)
Expands the row to show the content defined in Template property.
Declaration
public async System.Threading.Tasks.Task ExpandRow(TItem item)
Parameters
Type | Name | Description |
---|---|---|
TItem | item | The item. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task |
ExpandRows(IEnumerable<TItem>)
Expands a range of rows.
Declaration
public async System.Threading.Tasks.Task ExpandRows(IEnumerable<TItem> items)
Parameters
Type | Name | Description |
---|---|---|
IEnumerable<TItem> | items | The range of rows. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task |
GetComponentCssClass()
Gets the component CSS class.
Declaration
protected override string GetComponentCssClass()
Returns
Type | Description |
---|---|
System.String |
Overrides
InsertRow(TItem)
Inserts new row.
Declaration
public async System.Threading.Tasks.Task InsertRow(TItem item)
Parameters
Type | Name | Description |
---|---|---|
TItem | item | The item. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task |
IsRowExpanded(TItem)
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 |
---|---|
System.Boolean |
IsRowInEditMode(TItem)
Determines whether row in edit mode.
Declaration
public bool IsRowInEditMode(TItem item)
Parameters
Type | Name | Description |
---|---|---|
TItem | item | The item. |
Returns
Type | Description |
---|---|
System.Boolean |
|
ItemEquals(TItem, TItem)
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 |
---|---|
System.Boolean | Are items equal |
OnAfterRenderAsync(Boolean)
Called when [after render asynchronous].
Declaration
protected override async Task OnAfterRenderAsync(bool firstRender)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | firstRender | if set to |
Returns
Type | Description |
---|---|
Task | Task. |
Overrides
OnCollectionChanged(Object, NotifyCollectionChangedEventArgs)
Called when INotifyCollectionChanged CollectionChanged is raised.
Declaration
protected override void OnCollectionChanged(object sender, NotifyCollectionChangedEventArgs args)
Parameters
Type | Name | Description |
---|---|---|
System.Object | sender | |
NotifyCollectionChangedEventArgs | args |
Overrides
OnColumnResized(Int32, Double)
Called when column is resized.
Declaration
public async Task OnColumnResized(int columnIndex, double value)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | columnIndex | Index of the column. |
System.Double | value | The value. |
Returns
Type | Description |
---|---|
Task |
OnDataChanged()
Called when data is changed.
Declaration
protected override void OnDataChanged()
Overrides
OnFilter(ChangeEventArgs, RadzenDataGridColumn<TItem>, Boolean, Boolean)
Called when filter.
Declaration
protected virtual async Task OnFilter(ChangeEventArgs args, RadzenDataGridColumn<TItem> column, bool force = false, bool isFirst = true)
Parameters
Type | Name | Description |
---|---|---|
ChangeEventArgs | args | The |
RadzenDataGridColumn<TItem> | column | The column. |
System.Boolean | force | if set to |
System.Boolean | isFirst | if set to |
Returns
Type | Description |
---|---|
Task |
OnFilterKeyPress(EventArgs, RadzenDataGridColumn<TItem>)
Called when filter key pressed.
Declaration
protected virtual void OnFilterKeyPress(EventArgs args, RadzenDataGridColumn<TItem> column)
Parameters
Type | Name | Description |
---|---|---|
EventArgs | args | The |
RadzenDataGridColumn<TItem> | column | The column. |
OnKeyDown(KeyboardEventArgs)
Handles the KeyDown event.
Declaration
protected virtual async Task OnKeyDown(KeyboardEventArgs args)
Parameters
Type | Name | Description |
---|---|---|
KeyboardEventArgs | args | The |
Returns
Type | Description |
---|---|
Task |
OnPageSizeChanged(Int32)
Called when [page size changed].
Declaration
protected override async Task OnPageSizeChanged(int value)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | value | The value. |
Returns
Type | Description |
---|---|
Task |
Overrides
OnParametersSetAsync()
Called when parameters set asynchronous.
Declaration
protected override Task OnParametersSetAsync()
Returns
Type | Description |
---|---|
Task | Task. |
Overrides
OrderBy(String)
Orders the DataGrid by property name.
Declaration
public void OrderBy(string property)
Parameters
Type | Name | Description |
---|---|---|
System.String | property | The property name. |
OrderByDescending(String)
Orders descending the DataGrid by property name.
Declaration
public void OrderByDescending(string property)
Parameters
Type | Name | Description |
---|---|---|
System.String | property | The property name. |
Reload()
Reloads this instance.
Declaration
public override async Task Reload()
Returns
Type | Description |
---|---|
Task |
Overrides
Reset(Boolean, Boolean)
Resets the DataGrid instance to initial state with no sorting, grouping and/or filtering, column visibility.
Declaration
public void Reset(bool resetColumnState = true, bool resetRowState = false)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | resetColumnState | if set to |
System.Boolean | resetRowState | if set to |
SelectRow(TItem, Boolean)
Selects the row.
Declaration
public async System.Threading.Tasks.Task SelectRow(TItem item, bool raiseEvent = true)
Parameters
Type | Name | Description |
---|---|---|
TItem | item | The item. |
System.Boolean | raiseEvent | Should raise RowSelect event. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task |
SetParametersAsync(ParameterView)
Set parameters as an asynchronous operation.
Declaration
public override async Task SetParametersAsync(ParameterView parameters)
Parameters
Type | Name | Description |
---|---|---|
ParameterView | parameters | The parameters. |
Returns
Type | Description |
---|---|
Task | A Task representing the asynchronous operation. |
Overrides
UpdatePickableColumns()
Updates pickable columns.
Declaration
public void UpdatePickableColumns()
UpdateRow(TItem)
Updates the row.
Declaration
public async System.Threading.Tasks.Task UpdateRow(TItem item)
Parameters
Type | Name | Description |
---|---|---|
TItem | item | The item. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task |