Blazorise DataGrid: Getting Started
The DataGrid component is used for displaying tabular data. Features include sorting, filtering, paging, inline editing, and row selection.
See DataGrid specifications for behavior details and edge cases.
To create a basic grid in Blazorise, define the columns that describe the grid structure and behavior.
<DataGrid>the main container<DataGridColumns>container for datagrid columns<DataGridColumn>column template for text editor<DataGridNumericColumn>column template for numeric values<DataGridDateColumn>column template for datetime values<DataGridCheckColumn>column template for boolean values<DataGridSelectColumn>column template for selectable values<DataGridCommandColumn>column template for editing commands like Edit, Save, Cancel, etc.
<DataGridAggregates>container for datagrid aggregates<DataGridAggregate>defines the column and aggregation function type
To use the DataGrid component, install the Blazorise.DataGrid package first.
Installation
NuGet
Install extension from NuGet.Install-Package Blazorise.DataGrid
Imports
In your main _Imports.razor add:
@using Blazorise.DataGrid
Usage
DataGrid
For DataGrid the required fields areTItem typeparam and Data attribute. Other attributes on the DataGrid are optional.
Columns
Next you must set the Columns that you want to see in the grid. When defining the columns the required fields are:TItemthis is always the same model as onDataGrid. And you should be able to omit this on recent versions of Blazorise
Field name of the field in the supplied model.
Caption the column caption text.
nameof when defining the Field Parameter.
Note that nameof produces only the name of the variable, type or member as the string constant. It is used as a way to strongly type the string that represents our field.
Please note, that this is not mandatory. And you may provide a regular string that represents the path to the field you want to be binding.
Nested fields
Field attribute also supports nested fields. You can define a column with field name like"City.Country.Name" and it will work. Just keep in mind that when editing nested fields they must be initialized first or otherwise they will raise an exception.
CascadingTypeParameter feature. We've found out, that there might be a few caveats when using the feature. For most cases you'll be just fine with removing the explicit references to the Generic Type on the children component. But for the very few cases that Blazor complains that it cannot compile, just explicitly define the Generic Type.
Here's an example:
This will not work:
<DataGridAggregate Field="@nameof( Employee.IsActive )" AggregationFunction=@(DataGridAggregate<Employee>.TrueCount) />
These will work:
<DataGridAggregate Field="@nameof( Employee.IsActive )" AggregationFunction=@((x,y) => DataGridAggregate<Employee>.TrueCount(x,y)) />
<DataGridAggregate TItem="Employee" Field="@nameof( Employee.IsActive )" AggregationFunction=@(DataGridAggregate<Employee>.TrueCount) />
API
Parameters
DataGrid
| Parameter | Description | Type | Default |
|---|---|---|---|
AggregateData |
Specifies the aggregate data shown when using manual read mode. RemarksUsed only in manual read mode along with the ReadData handler. |
IEnumerable<TItem> | null |
AggregateRowPosition |
Specifies the position of the aggregate row. Possible values: |
DataGridAggregateRowPosition | DataGridAggregateRowPosition.Bottom |
AggregateRowStyling |
Custom styles for aggregate row. |
DataGridRowStyling | null |
Attributes |
Captures all the custom attribute that are not part of Blazorise component. |
Dictionary<string, object> | null |
AutoGenerateColumns |
Determines whether the DataGrid should automatically generate columns. Columns will only be automatically generated if no columns have been provided. Defaults to true. |
bool | true |
BatchEdit |
Whether the DataGrid will be in batch edit mode. This will make it so every change will only be saved when Save is called. |
bool | false |
Bordered |
Adds borders to all the cells. |
bool | false |
Borderless |
Makes the table without any borders. |
bool | false |
ButtonRowTemplate |
Defines content of button row of pager. |
RenderFragment<ButtonRowContext<TItem>> | null |
Caption |
Specifies the caption of the table, usually used to describe the table content. |
string | |
CaptionSide |
Specifies the placement of the Caption element. Possible values: |
TableCaptionSide | Default |
ChildContent |
Specifies the content to be rendered inside this DataGrid. |
RenderFragment | null |
Class |
Custom css classname. |
string | |
Classes |
Supplies additional CSS classes for DataGrid elements. |
DataGridClasses | null |
ColumnChooserTemplate |
Defines content of column chooser of pager. |
RenderFragment<ColumnChooserContext<TItem>> | null |
CommandMode |
Specifies the grid command mode. Possible values: |
DataGridCommandMode | DataGridCommandMode.Default |
CustomFilter |
Handler for custom filtering on datagrid item. |
DataGridCustomFilter<TItem> | null |
Data |
Specifies the data source displayed by the data grid. |
IEnumerable<TItem> | null |
DataGridAggregates |
Template for holding the datagrid aggregate columns. |
RenderFragment | null |
DataGridColumns |
Template for holding the datagrid columns. |
RenderFragment | null |
DetailRowStartsVisible |
Controls whether DetailRow will start visible if DetailRowTemplate is set. DetailRowTrigger will be evaluated if set. |
bool | true |
DetailRowTemplate |
Template for displaying detail or nested row. |
RenderFragment<DetailRowContext<TItem>> | null |
Editable |
Determines whether users can edit datagrid rows. |
bool | false |
EditMode |
Specifies the grid editing modes. Possible values: |
DataGridEditMode | DataGridEditMode.Form |
EditModeOptions |
Specifies DataGridEditMode options, allowing to customize how the edit mode will work. |
DataGridEditModeOptions | null |
ElementId |
Specifies the datagrid element id. |
string | |
EmptyCellTemplate |
Defines content of cell body for empty DisplayData. |
RenderFragment<CellDisplayContext<TItem>> | null |
EmptyFilterTemplate |
Defines content of table body for the empty filter DisplayData. |
RenderFragment | null |
EmptyTemplate |
Defines content of table body for empty DisplayData. |
RenderFragment | null |
ExpandedRows |
Specifies the currently expanded self-reference rows. |
IList<TItem> | null |
ExpandMode |
Specifies row expand mode. Possible values: |
DataGridExpandMode | DataGridExpandMode.Multiple |
ExpandOptions |
Specifies row expand related behavior options. |
DataGridExpandOptions | null |
ExpandTrigger |
Specifies how a row expansion can be triggered. Possible values: |
DataGridExpandTrigger | DataGridExpandTrigger.ToggleClick |
Filterable |
Determines whether users can filter rows by its cell values. |
bool | false |
FilterMenuTemplate |
Template for the filter column. When filter mode is set to DataGridFilterMode.Menu, this template will be used to render the filter content. |
RenderFragment<FilterColumnContext<TItem>> | null |
FilterMethod |
Specifies the filter method to be applied when filtering data in the grid. Possible values: |
DataGridFilterMethod | DataGridFilterMethod.Default |
FilterMode |
Specifies the filter mode. Possible values: |
DataGridFilterMode | DataGridFilterMode.Default |
FilterRowStyling |
Custom styles for filter row. |
DataGridRowStyling | null |
FirstPageButtonTemplate |
Defines content of first button of pager. |
RenderFragment | null |
FixedColumns |
Makes Datagrid have a fixed set of columns. This will make it so that the table columns could be fixed to the side of the table. |
bool | false |
FixedColumnsPositionSync |
Determines whether the FixedColumns feature automatically resynchronizes the columns positions when they are added or removed. RemarksEnabling this feature may impact performance due to constant recalculations of fixed column positions. |
bool | false |
FixedHeader |
Makes Datagrid have a fixed header and enabling a scrollbar in the Datagrid body. |
bool | false |
FixedHeaderDataGridHeight |
Sets the Datagrid height when FixedHeader feature is enabled (defaults to 500px). |
string | "500px" |
FixedHeaderDataGridMaxHeight |
Sets the Datagrid max height when FixedHeader feature is enabled (defaults to 500px). |
string | "500px" |
Groupable |
Determines whether the data will be grouped. Column groups need to be configured. |
bool | false |
HeaderGroupCaptionTemplate |
Template for header group caption. Suggested usage: rendering content conditionally according to the defined HeaderGroupCaption |
RenderFragment<HeaderGroupContext> | null |
HeaderRowStyling |
Custom styles for header row. |
DataGridRowStyling | null |
HeaderThemeContrast |
Sets the Datagrid's table header ThemeContrast. Possible values: |
ThemeContrast | None |
Hoverable |
Adds a hover effect when mousing over rows. |
bool | false |
ItemsPerPageTemplate |
Defines content of items per page of grid. |
RenderFragment | null |
LastPageButtonTemplate |
Defines content of last button of pager. |
RenderFragment | null |
LoadingTemplate |
Defines content of table body for handle ReadData. |
RenderFragment | null |
Localizers |
Custom localizer handlers to override default DataGrid localization. |
DataGridLocalizers | null |
Margin |
Specifies the element margin spacing. |
IFluentSpacing | null |
MaxPaginationLinks |
Specifies the maximum number of visible pagination links. It has to be odd for well look. |
int | 0 |
Narrow |
Makes the table more compact by cutting cell padding in half. |
bool | false |
NavigationMode |
Specifies the DataGrid navigation mode, allowing to control the navigation via keyboard. Possible values: |
DataGridNavigationMode | DataGridNavigationMode.Default |
NextPageButtonTemplate |
Defines content of next button of pager. |
RenderFragment | null |
Padding |
Specifies the element padding spacing. |
IFluentSpacing | null |
Page |
Specifies the current page number. |
int | 0 |
PageButtonTemplate |
Defines content of page buttons of pager. |
RenderFragment<PageButtonContext> | null |
PagerOptions |
Specifies Pager options. |
DataGridPagerOptions | null |
PagerPosition |
Specifies the position of the pager. Possible values: |
DataGridPagerPosition | DataGridPagerPosition.Bottom |
PageSelectorTemplate |
Defines content of the page selector. The selector is only displayed under the tablets breakpoint. You will have to construct it using the provided pagination context. |
RenderFragment<PaginationContext<TItem>> | null |
PageSize |
Specifies the maximum number of items for each page. |
int | 0 |
PageSizes |
Specifies the chooseable page sizes of the datagrid. |
IEnumerable<int> | null |
PageSizesTemplate |
Defines content of the page sizes selector. You will have to construct it using the provided pagination context. |
RenderFragment<PaginationContext<TItem>> | null |
PopupSize |
Specifies the size of popup dialog. Possible values: |
ModalSize | Default |
PopupTitleTemplate |
Gets template for title of popup modal. |
RenderFragment<PopupTitleContext<TItem>> | context =>
{
return builder =>
{
builder.AddContent( 0, context.EditState == DataGridEditState.Edit ? "Row Edit" : "Row Create" );
};
} |
PreviousPageButtonTemplate |
Defines content of previous button of pager. |
RenderFragment | null |
Resizable |
Determines whether users can resize datagrid columns. |
bool | false |
ResizeMode |
Determines whether the user can resize on header or columns. Possible values: |
TableResizeMode | Header |
Responsive |
Makes table responsive by adding the horizontal scroll bar. RemarksIn some cases Dropdown component placed inside of a table marked with Responsive flag might not show dropdown menu properly. To make it work you might need to add some additional CSS rules. |
bool | false |
ResponsiveMode |
Specifies the Table's responsive mode. Possible values: |
TableResponsiveMode | Default |
RowContextMenuPreventDefault |
Used to prevent the default action for an RowContextMenu event. |
bool | false |
RowOverlayBackground |
Specifies the background of the row overlay. |
Background | Light |
RowOverlayPosition |
Specifies the position of the row overlay. Possible values: |
DataGridRowOverlayPosition | DataGridRowOverlayPosition.End |
RowOverlayTemplate |
Template for mouse hover overlay display formatting. |
RenderFragment<RowOverlayContext<TItem>> | null |
SelectedCell |
Specifies the currently selected cell in the data grid. RemarksThis property is only applicable when NavigationMode is set to Cell. |
DataGridCellInfo<TItem> | null |
SelectedRow |
Specifies the currently selected tree row item. |
TItem | null |
SelectedRows |
Specifies the currently selected rows. |
List<TItem> | null |
SelectionMode |
Specifies the current selection mode. Possible values: |
DataGridSelectionMode | DataGridSelectionMode.Single |
ShowCaptions |
Determines whether user can see a column captions. |
bool | true |
ShowColumnChooser |
Determines whether the column chooser is visible. |
bool | false |
ShowDefaultSortIcon |
Determines whether default sort icon should display. |
bool | false |
ShowGrouping |
Determines whether user can see and edit column grouping. |
bool | false |
ShowHeaderGroupCaptions |
Determines whether user can see defined header group captions. |
bool | false |
ShowPager |
Determines whether users can navigate datagrid by using pagination controls. |
bool | false |
ShowPageSizes |
Determines whether users can adjust the page size of the datagrid. |
bool | false |
ShowValidationFeedback |
If true, shows feedbacks for all validations. |
bool | false |
ShowValidationsSummary |
If true, shows summary for all validations. |
bool | true |
Sortable |
Determines whether end-users can sort data by the column's values. |
bool | true |
SortMode |
Determines whether the user can sort only by one column or by multiple. Possible values: |
DataGridSortMode | DataGridSortMode.Multiple |
Striped |
Adds stripes to the table. |
bool | false |
Style |
Custom html style. |
string | |
Styles |
Supplies additional CSS styles for DataGrid elements. |
DataGridStyles | null |
SubmitFormOnEnter |
If true, the edit form will have the Save button as |
bool | true |
TotalItems |
Specifies the total number of items available when data is loaded through ReadData. RemarksThis field must be set only when ReadData is used to load the data. |
int? | null |
TotalItemsShortTemplate |
Defines content of total items grid for small devices. |
RenderFragment<PaginationContext<TItem>> | null |
TotalItemsTemplate |
Defines content of total items grid. |
RenderFragment<PaginationContext<TItem>> | null |
UseInternalEditing |
Specifies the behaviour of datagrid editing. RemarksDisabling this option will send all changes to the RowInserted and RowUpdated but nothing will be saved unless the user manually update the item values. |
bool | true |
UseValidation |
If true, DataGrid will use validation when editing the fields. |
bool | false |
ValidationsHandlerType |
Specifies the default handler type that will be used by the validation, unless it is overriden by HandlerType property. |
Type | null |
ValidationsSummaryErrors |
List of custom error messages for the validations summary. |
string[] | null |
ValidationsSummaryLabel |
Label for validations summary. |
string | |
Virtualize |
Determines whether the datagrid will use the Virtualize functionality. |
bool | false |
VirtualizeOptions |
Specifies Virtualize options when using the Virtualize functionality. |
VirtualizeOptions | null |
DataGridColumn
| Parameter | Description | Type | Default |
|---|---|---|---|
AggregateCellClass |
Custom classname for the aggregate cell. |
string | |
AggregateCellStyle |
Custom style for the aggregate cell. |
string | |
AggregateDisplay |
Specifies the display behavior of a the aggregate cell. |
IFluentDisplay | null |
AggregateFlex |
Specifies the flex utility of a the aggregate cell. |
IFluentFlex | null |
AggregateGap |
Specifies the gap utility of a the aggregate cell. |
IFluentGap | null |
AggregateTemplate |
Template for aggregate values. |
RenderFragment<AggregateContext<TItem>> | null |
AggregateTextAlignment |
Specifies the alignment for column the aggregate cell. If not set, it will fallback to the TextAlignment. |
TextAlignment? | null |
AggregateTextDecoration |
Specifies the text decoration for column the aggregate cell. If not set, it will fallback to the TextDecoration. |
TextDecoration? | null |
AggregateTextOverflow |
Determines how the text will behave when it is larger than a parent container for column the aggregate cell. If not set, it will fallback to the TextOverflow. |
TextOverflow? | null |
AggregateTextSize |
Determines the font size of an element for column the aggregate cell. If not set, it will fallback to the TextSize. |
IFluentTextSize | null |
AggregateTextTransform |
Specifies the text transformation for column the aggregate cell. If not set, it will fallback to the TextTransform. |
TextTransform? | null |
AggregateTextWeight |
Specifies the text weight for column the aggregate cell. If not set, it will fallback to the TextWeight. |
TextWeight? | null |
AggregateVerticalAlignment |
Specifies the vertical alignment for column the aggregate cell. |
VerticalAlignment? | null |
Caption |
Specifies the column's display caption. |
string | |
CaptionTemplate |
Defines the column's display caption template. |
RenderFragment<DataGridColumn<TItem>> | null |
CellsEditableOnEditCommand |
Allows the cell values to be entered while the grid is in the edit-item state. |
bool | true |
CellsEditableOnNewCommand |
Allows the cell values to be entered while the grid is in the new-item state. |
bool | true |
ChildContent |
Specifies the content to be rendered inside this DataGridColumn. |
RenderFragment | null |
CustomFilter |
Custom filter function used to override internal filtering. |
DataGridColumnCustomFilter | null |
Display |
Specifies the display utility of a cell. |
IFluentDisplay | null |
Displayable |
Determines whether column can be displayed on a grid. |
bool | true |
DisplayFormat |
Specifies the format for display value. |
string | |
DisplayFormatProvider |
Specifies the format provider info for display value. |
IFormatProvider | null |
Displaying |
Specifies the default visibility of the column. This parameter is only used as the initial/default state; runtime visibility is managed by column visibility actions. |
bool | true |
DisplayOrder |
Specifies the initial display order of the column. |
int | 0 |
DisplayTemplate |
Template for custom cell display formatting. |
RenderFragment<CellDisplayContext<TItem>> | null |
Editable |
Determines whether users can edit cell values under this column. |
bool | false |
EditFieldColumnSize |
Specifies the size of an edit field for popup modal and edit form. |
IFluentColumn | null |
EditOrder |
Specifies the initial display order of the column. |
int? | null |
EditTemplate |
Template for custom cell editing. |
RenderFragment<CellEditContext<TItem>> | null |
ElementId |
Specifies the datagrid element id. |
string | |
ExpandTemplate |
Template used to customize self-reference expand rendering. The first regular column that defines this template becomes the self-reference host column. |
RenderFragment<DataGridExpandRowContext<TItem>> | null |
Field |
To bind a column to a data source field, set this property to the required data field name. |
string | |
Filter |
Filter value for this column. |
FilterContext<TItem> | new() |
Filterable |
Determines whether users can filter rows by its cell values. |
bool | true |
FilterCellClass |
Custom classname for filter cell. |
string | |
FilterCellStyle |
Custom style for filter cell. |
string | |
FilterDisplay |
Specifies the display behavior of a filter cell. |
IFluentDisplay | null |
FilterFlex |
Specifies the flex utility of a filter cell. |
IFluentFlex | null |
FilterGap |
Specifies the gap utility of a filter cell. |
IFluentGap | null |
FilterMethod |
Sets the filter method to be used for filtering the column. If null, uses the FilterMethod |
DataGridColumnFilterMethod? | null |
FilterMode |
Gets or sets the filter mode for the column. If set, this overrides the FilterMethod. |
DataGridFilterMode? | null |
FilterTemplate |
Template for custom column filter rendering. |
RenderFragment<FilterContext<TItem>> | null |
FilterTextAlignment |
Specifies the alignment for column filter cell. If not set, it will fallback to the TextAlignment. |
TextAlignment? | null |
FilterTextDecoration |
Specifies the text decoration for column filter cell. If not set, it will fallback to the TextDecoration. |
TextDecoration? | null |
FilterTextOverflow |
Determines how the text will behave when it is larger than a parent container for column filter cell. If not set, it will fallback to the TextOverflow. |
TextOverflow? | null |
FilterTextSize |
Determines the font size of an element for column filter cell. If not set, it will fallback to the TextSize. |
IFluentTextSize | null |
FilterTextTransform |
Specifies the text transformation for column filter cell. If not set, it will fallback to the TextTransform. |
TextTransform? | null |
FilterTextWeight |
Specifies the text weight for column filter cell. If not set, it will fallback to the TextWeight. |
TextWeight? | null |
FilterVerticalAlignment |
Specifies the vertical alignment for column filter cell. |
VerticalAlignment? | null |
FixedPosition |
Specifies the fixed position of the row cell within the table. Possible values: |
TableColumnFixedPosition | None |
Flex |
Specifies the flex utility of a cell. |
IFluentFlex | null |
Gap |
Specifies the gap utility of a cell. |
IFluentGap | null |
Groupable |
Determines whether the column is eligible to be used as a Group Field. A custom GroupBy function can however be provided. |
bool | false |
Grouping |
Determines whether the column should start grouped. |
bool | false |
GroupTemplate |
Template for custom group. |
RenderFragment<GroupContext<TItem>> | null |
HeaderCellClass |
Custom classname for header cell. |
string | |
HeaderCellStyle |
Custom style for header cell. |
string | |
HeaderDisplay |
Specifies the display behavior of a header cell. |
IFluentDisplay | null |
HeaderFlex |
Specifies the flex utility of a header cell. |
IFluentFlex | null |
HeaderGap |
Specifies the gap utility of a header cell. |
IFluentGap | null |
HeaderGroupCaption |
Defines the caption to be displayed for a group header. If set, all the column headers that are part of the group will be grouped under this caption. |
string | |
HeaderTextAlignment |
Specifies the alignment for column header cell. If not set, it will fallback to the TextAlignment. |
TextAlignment? | null |
HeaderTextDecoration |
Specifies the text decoration for column header cell. If not set, it will fallback to the TextDecoration. |
TextDecoration? | null |
HeaderTextOverflow |
Determines how the text will behave when it is larger than a parent container for column header cell. If not set, it will fallback to the TextOverflow. |
TextOverflow? | null |
HeaderTextSize |
Determines the font size of an element for column header cell. If not set, it will fallback to the TextSize. |
IFluentTextSize | null |
HeaderTextTransform |
Specifies the text transformation for column header cell. If not set, it will fallback to the TextTransform. |
TextTransform? | null |
HeaderTextWeight |
Specifies the text weight for column header cell. If not set, it will fallback to the TextWeight. |
TextWeight? | null |
HeaderVerticalAlignment |
Specifies the vertical alignment for column header cell. |
VerticalAlignment? | null |
HelpText |
Sets the help-text positioned below the field input when editing. |
string | |
PreventRowClick |
Will set @onclick:StopProgration to true, stopping the RowClick and consequent events from triggering. |
bool | false |
Readonly |
Determines whether end-users are prevented from editing the column's cell values. |
bool | false |
Reorderable |
Specifies a value indicating whether the column can be reordered by the user. |
bool | false |
ReverseSorting |
Determines whether the sort direction will be reversed. |
bool | false |
ShowCaption |
Determines whether the column's caption is displayed within the column header. |
bool | true |
Sortable |
Determines whether end-users can sort data by the column's values. |
bool | true |
SortComparer |
Specifies the custom comparer used for sorting the items in this column. Note that this comparer can only be used with in-memory data. |
IComparer<TItem> | null |
SortDirection |
Specifies the column initial sort direction. Possible values: |
SortDirection | default(SortDirection) |
SortDirectionTemplate |
Defines the column's display sort direction template. |
RenderFragment<SortDirectionContext<TItem>> | null |
SortField |
Provides a Sort Field to be used instead by the Sorting mechanism |
string | |
SortOrder |
Specifies the order for sorting when Sorting is set to multiple. |
int | 0 |
TextAlignment |
Specifies the alignment for the table cell. Possible values: |
TextAlignment | Default |
TextDecoration |
Specifies the text decoration for the table cell. Possible values: |
TextDecoration | Default |
TextOverflow |
Determines how the text will behave when it is larger than a parent container for the table cell. Possible values: |
TextOverflow | Default |
TextSize |
Determines the font size of an element for the table cell. |
IFluentTextSize | null |
TextTransform |
Specifies the text transformation for the table cell. Possible values: |
TextTransform | Default |
TextWeight |
Specifies the text weight for the table cell. Possible values: |
TextWeight | Default |
ValidationPattern |
Forces validation to use regex pattern matching instead of default validator handler. |
string | |
VerticalAlignment |
Specifies the vertical alignment for the table cell. Possible values: |
VerticalAlignment | Default |
Width |
The width of the column. |
IFluentSizing | null |
DataGridCommandColumn
| Parameter | Description | Type | Default |
|---|---|---|---|
AggregateCellClass |
Custom classname for the aggregate cell. |
string | |
AggregateCellStyle |
Custom style for the aggregate cell. |
string | |
AggregateDisplay |
Specifies the display behavior of a the aggregate cell. |
IFluentDisplay | null |
AggregateFlex |
Specifies the flex utility of a the aggregate cell. |
IFluentFlex | null |
AggregateGap |
Specifies the gap utility of a the aggregate cell. |
IFluentGap | null |
AggregateTemplate |
Template for aggregate values. |
RenderFragment<AggregateContext<TItem>> | null |
AggregateTextAlignment |
Specifies the alignment for column the aggregate cell. If not set, it will fallback to the TextAlignment. |
TextAlignment? | null |
AggregateTextDecoration |
Specifies the text decoration for column the aggregate cell. If not set, it will fallback to the TextDecoration. |
TextDecoration? | null |
AggregateTextOverflow |
Determines how the text will behave when it is larger than a parent container for column the aggregate cell. If not set, it will fallback to the TextOverflow. |
TextOverflow? | null |
AggregateTextSize |
Determines the font size of an element for column the aggregate cell. If not set, it will fallback to the TextSize. |
IFluentTextSize | null |
AggregateTextTransform |
Specifies the text transformation for column the aggregate cell. If not set, it will fallback to the TextTransform. |
TextTransform? | null |
AggregateTextWeight |
Specifies the text weight for column the aggregate cell. If not set, it will fallback to the TextWeight. |
TextWeight? | null |
AggregateVerticalAlignment |
Specifies the vertical alignment for column the aggregate cell. |
VerticalAlignment? | null |
CancelBatchCommandAllowed |
Handles the visibility of cancel batch command button. |
bool | true |
CancelBatchCommandTemplate |
Template to customize cancel batch command button. |
RenderFragment<CommandContext> | null |
CancelCommandAllowed |
Handles the visibility of cancel command button. |
bool | true |
CancelCommandTemplate |
Template to customize cancel command button. |
RenderFragment<CommandContext<TItem>> | null |
Caption |
Specifies the column's display caption. |
string | |
CaptionTemplate |
Defines the column's display caption template. |
RenderFragment<DataGridColumn<TItem>> | null |
CellsEditableOnEditCommand |
Allows the cell values to be entered while the grid is in the edit-item state. |
bool | true |
CellsEditableOnNewCommand |
Allows the cell values to be entered while the grid is in the new-item state. |
bool | true |
ChildContent |
Specifies the content to be rendered inside this DataGridCommandColumn. |
RenderFragment | null |
ClearFilterCommandAllowed |
Handles the visibility of clear-filter command button. |
bool | true |
ClearFilterCommandTemplate |
Template to customize clear-filter command button. |
RenderFragment<CommandContext<TItem>> | null |
CustomFilter |
Custom filter function used to override internal filtering. |
DataGridColumnCustomFilter | null |
DeleteCommandAllowed |
Handles the visibility of delete command button. |
bool | true |
DeleteCommandTemplate |
Template to customize delete command button. |
RenderFragment<DeleteCommandContext<TItem>> | null |
Display |
Specifies the display utility of a cell. |
IFluentDisplay | null |
Displayable |
Determines whether column can be displayed on a grid. |
bool | true |
DisplayFormat |
Specifies the format for display value. |
string | |
DisplayFormatProvider |
Specifies the format provider info for display value. |
IFormatProvider | null |
Displaying |
Specifies the default visibility of the column. This parameter is only used as the initial/default state; runtime visibility is managed by column visibility actions. |
bool | true |
DisplayOrder |
Specifies the initial display order of the column. |
int | 0 |
DisplayTemplate |
Template for custom cell display formatting. |
RenderFragment<CellDisplayContext<TItem>> | null |
Editable |
Determines whether users can edit cell values under this column. |
bool | false |
EditCommandAllowed |
Handles the visibility of edit command button. |
bool | true |
EditCommandTemplate |
Template to customize edit command button. |
RenderFragment<EditCommandContext<TItem>> | null |
EditFieldColumnSize |
Specifies the size of an edit field for popup modal and edit form. |
IFluentColumn | null |
EditOrder |
Specifies the initial display order of the column. |
int? | null |
EditTemplate |
Template for custom cell editing. |
RenderFragment<CellEditContext<TItem>> | null |
ElementId |
Specifies the datagrid element id. |
string | |
ExpandTemplate |
Template used to customize self-reference expand rendering. The first regular column that defines this template becomes the self-reference host column. |
RenderFragment<DataGridExpandRowContext<TItem>> | null |
Field |
To bind a column to a data source field, set this property to the required data field name. |
string | |
Filter |
Filter value for this column. |
FilterContext<TItem> | new() |
Filterable |
Determines whether users can filter rows by its cell values. |
bool | true |
FilterCellClass |
Custom classname for filter cell. |
string | |
FilterCellStyle |
Custom style for filter cell. |
string | |
FilterDisplay |
Specifies the display behavior of a filter cell. |
IFluentDisplay | null |
FilterFlex |
Specifies the flex utility of a filter cell. |
IFluentFlex | null |
FilterGap |
Specifies the gap utility of a filter cell. |
IFluentGap | null |
FilterMethod |
Sets the filter method to be used for filtering the column. If null, uses the FilterMethod |
DataGridColumnFilterMethod? | null |
FilterMode |
Gets or sets the filter mode for the column. If set, this overrides the FilterMethod. |
DataGridFilterMode? | null |
FilterTemplate |
Template for custom column filter rendering. |
RenderFragment<FilterContext<TItem>> | null |
FilterTextAlignment |
Specifies the alignment for column filter cell. If not set, it will fallback to the TextAlignment. |
TextAlignment? | null |
FilterTextDecoration |
Specifies the text decoration for column filter cell. If not set, it will fallback to the TextDecoration. |
TextDecoration? | null |
FilterTextOverflow |
Determines how the text will behave when it is larger than a parent container for column filter cell. If not set, it will fallback to the TextOverflow. |
TextOverflow? | null |
FilterTextSize |
Determines the font size of an element for column filter cell. If not set, it will fallback to the TextSize. |
IFluentTextSize | null |
FilterTextTransform |
Specifies the text transformation for column filter cell. If not set, it will fallback to the TextTransform. |
TextTransform? | null |
FilterTextWeight |
Specifies the text weight for column filter cell. If not set, it will fallback to the TextWeight. |
TextWeight? | null |
FilterVerticalAlignment |
Specifies the vertical alignment for column filter cell. |
VerticalAlignment? | null |
FixedPosition |
Specifies the fixed position of the row cell within the table. Possible values: |
TableColumnFixedPosition | None |
Flex |
Specifies the flex utility of a cell. |
IFluentFlex | null |
Gap |
Specifies the gap utility of a cell. |
IFluentGap | null |
Groupable |
Determines whether the column is eligible to be used as a Group Field. A custom GroupBy function can however be provided. |
bool | false |
Grouping |
Determines whether the column should start grouped. |
bool | false |
GroupTemplate |
Template for custom group. |
RenderFragment<GroupContext<TItem>> | null |
HeaderCellClass |
Custom classname for header cell. |
string | |
HeaderCellStyle |
Custom style for header cell. |
string | |
HeaderDisplay |
Specifies the display behavior of a header cell. |
IFluentDisplay | null |
HeaderFlex |
Specifies the flex utility of a header cell. |
IFluentFlex | null |
HeaderGap |
Specifies the gap utility of a header cell. |
IFluentGap | null |
HeaderGroupCaption |
Defines the caption to be displayed for a group header. If set, all the column headers that are part of the group will be grouped under this caption. |
string | |
HeaderTextAlignment |
Specifies the alignment for column header cell. If not set, it will fallback to the TextAlignment. |
TextAlignment? | null |
HeaderTextDecoration |
Specifies the text decoration for column header cell. If not set, it will fallback to the TextDecoration. |
TextDecoration? | null |
HeaderTextOverflow |
Determines how the text will behave when it is larger than a parent container for column header cell. If not set, it will fallback to the TextOverflow. |
TextOverflow? | null |
HeaderTextSize |
Determines the font size of an element for column header cell. If not set, it will fallback to the TextSize. |
IFluentTextSize | null |
HeaderTextTransform |
Specifies the text transformation for column header cell. If not set, it will fallback to the TextTransform. |
TextTransform? | null |
HeaderTextWeight |
Specifies the text weight for column header cell. If not set, it will fallback to the TextWeight. |
TextWeight? | null |
HeaderVerticalAlignment |
Specifies the vertical alignment for column header cell. |
VerticalAlignment? | null |
HelpText |
Sets the help-text positioned below the field input when editing. |
string | |
NewCommandAllowed |
Handles the visibility of new command button. |
bool | true |
NewCommandTemplate |
Template to customize new command button. |
RenderFragment<NewCommandContext<TItem>> | null |
PreventRowClick |
Will set @onclick:StopProgration to true, stopping the RowClick and consequent events from triggering. |
bool | false |
Readonly |
Determines whether end-users are prevented from editing the column's cell values. |
bool | false |
Reorderable |
Specifies a value indicating whether the column can be reordered by the user. |
bool | false |
ReverseSorting |
Determines whether the sort direction will be reversed. |
bool | false |
SaveBatchCommandAllowed |
Handles the visibility of save batch command button. |
bool | true |
SaveBatchCommandTemplate |
Template to customize save batch command button. |
RenderFragment<CommandContext> | null |
SaveCommandAllowed |
Handles the visibility of save command button. |
bool | true |
SaveCommandTemplate |
Template to customize save command button. |
RenderFragment<CommandContext<TItem>> | null |
ShowCaption |
Determines whether the column's caption is displayed within the column header. |
bool | true |
Sortable |
Determines whether end-users can sort data by the column's values. |
bool | true |
SortComparer |
Specifies the custom comparer used for sorting the items in this column. Note that this comparer can only be used with in-memory data. |
IComparer<TItem> | null |
SortDirection |
Specifies the column initial sort direction. Possible values: |
SortDirection | default(SortDirection) |
SortDirectionTemplate |
Defines the column's display sort direction template. |
RenderFragment<SortDirectionContext<TItem>> | null |
SortField |
Provides a Sort Field to be used instead by the Sorting mechanism |
string | |
SortOrder |
Specifies the order for sorting when Sorting is set to multiple. |
int | 0 |
TextAlignment |
Specifies the alignment for the table cell. Possible values: |
TextAlignment | Default |
TextDecoration |
Specifies the text decoration for the table cell. Possible values: |
TextDecoration | Default |
TextOverflow |
Determines how the text will behave when it is larger than a parent container for the table cell. Possible values: |
TextOverflow | Default |
TextSize |
Determines the font size of an element for the table cell. |
IFluentTextSize | null |
TextTransform |
Specifies the text transformation for the table cell. Possible values: |
TextTransform | Default |
TextWeight |
Specifies the text weight for the table cell. Possible values: |
TextWeight | Default |
ValidationPattern |
Forces validation to use regex pattern matching instead of default validator handler. |
string | |
VerticalAlignment |
Specifies the vertical alignment for the table cell. Possible values: |
VerticalAlignment | Default |
Width |
The width of the column. |
IFluentSizing | null |
DataGridSelectColumn
| Parameter | Description | Type | Default |
|---|---|---|---|
AggregateCellClass |
Custom classname for the aggregate cell. |
string | |
AggregateCellStyle |
Custom style for the aggregate cell. |
string | |
AggregateDisplay |
Specifies the display behavior of a the aggregate cell. |
IFluentDisplay | null |
AggregateFlex |
Specifies the flex utility of a the aggregate cell. |
IFluentFlex | null |
AggregateGap |
Specifies the gap utility of a the aggregate cell. |
IFluentGap | null |
AggregateTemplate |
Template for aggregate values. |
RenderFragment<AggregateContext<TItem>> | null |
AggregateTextAlignment |
Specifies the alignment for column the aggregate cell. If not set, it will fallback to the TextAlignment. |
TextAlignment? | null |
AggregateTextDecoration |
Specifies the text decoration for column the aggregate cell. If not set, it will fallback to the TextDecoration. |
TextDecoration? | null |
AggregateTextOverflow |
Determines how the text will behave when it is larger than a parent container for column the aggregate cell. If not set, it will fallback to the TextOverflow. |
TextOverflow? | null |
AggregateTextSize |
Determines the font size of an element for column the aggregate cell. If not set, it will fallback to the TextSize. |
IFluentTextSize | null |
AggregateTextTransform |
Specifies the text transformation for column the aggregate cell. If not set, it will fallback to the TextTransform. |
TextTransform? | null |
AggregateTextWeight |
Specifies the text weight for column the aggregate cell. If not set, it will fallback to the TextWeight. |
TextWeight? | null |
AggregateVerticalAlignment |
Specifies the vertical alignment for column the aggregate cell. |
VerticalAlignment? | null |
Attributes |
Captures all the custom attribute that are not part of Blazorise component. |
Dictionary<string, object> | null |
Caption |
Specifies the column's display caption. |
string | |
CaptionTemplate |
Defines the column's display caption template. |
RenderFragment<DataGridColumn<TItem>> | null |
CellsEditableOnEditCommand |
Allows the cell values to be entered while the grid is in the edit-item state. |
bool | true |
CellsEditableOnNewCommand |
Allows the cell values to be entered while the grid is in the new-item state. |
bool | true |
ChildContent |
Specifies the content to be rendered inside this DataGridSelectColumn. |
RenderFragment | null |
Class |
Custom css class-names. |
string | |
CustomFilter |
Custom filter function used to override internal filtering. |
DataGridColumnCustomFilter | null |
Data |
Specifies the select data source. |
IEnumerable<object> | null |
DefaultItemDisabled |
If true, disables the default item. |
bool | false |
DefaultItemHidden |
If true, disables the default item. |
bool | false |
DefaultItemText |
Display text of the default select item. |
string | |
DefaultItemValue |
Value of the default select item. |
object | null |
Disabled |
Add the disabled boolean attribute on an select to prevent user interactions and make it appear lighter. |
bool | false |
Display |
Specifies the display utility of a cell. |
IFluentDisplay | null |
Displayable |
Determines whether column can be displayed on a grid. |
bool | true |
DisplayFormat |
Specifies the format for display value. |
string | |
DisplayFormatProvider |
Specifies the format provider info for display value. |
IFormatProvider | null |
Displaying |
Specifies the default visibility of the column. This parameter is only used as the initial/default state; runtime visibility is managed by column visibility actions. |
bool | true |
DisplayOrder |
Specifies the initial display order of the column. |
int | 0 |
DisplayTemplate |
Template for custom cell display formatting. |
RenderFragment<CellDisplayContext<TItem>> | null |
Editable |
Determines whether users can edit cell values under this column. |
bool | false |
EditFieldColumnSize |
Specifies the size of an edit field for popup modal and edit form. |
IFluentColumn | null |
EditOrder |
Specifies the initial display order of the column. |
int? | null |
EditTemplate |
Template for custom cell editing. |
RenderFragment<CellEditContext<TItem>> | null |
ElementId |
Specifies the datagrid element id. |
string | |
ExpandTemplate |
Template used to customize self-reference expand rendering. The first regular column that defines this template becomes the self-reference host column. |
RenderFragment<DataGridExpandRowContext<TItem>> | null |
Field |
To bind a column to a data source field, set this property to the required data field name. |
string | |
Filter |
Filter value for this column. |
FilterContext<TItem> | new() |
Filterable |
Determines whether users can filter rows by its cell values. |
bool | true |
FilterCellClass |
Custom classname for filter cell. |
string | |
FilterCellStyle |
Custom style for filter cell. |
string | |
FilterDefaultItemDisabled |
If true, disables the default item in filter dropdowns. |
bool | false |
FilterDefaultItemHidden |
If true, hides the default item from filter dropdowns. |
bool | false |
FilterDefaultItemText |
Display text of the default item shown in filter dropdowns. |
string | |
FilterDefaultItemValue |
Value of the default item used in filter dropdowns. |
object | null |
FilterDisplay |
Specifies the display behavior of a filter cell. |
IFluentDisplay | null |
FilterFlex |
Specifies the flex utility of a filter cell. |
IFluentFlex | null |
FilterGap |
Specifies the gap utility of a filter cell. |
IFluentGap | null |
FilterMethod |
Sets the filter method to be used for filtering the column. If null, uses the FilterMethod |
DataGridColumnFilterMethod? | null |
FilterMode |
Gets or sets the filter mode for the column. If set, this overrides the FilterMethod. |
DataGridFilterMode? | null |
FilterTemplate |
Template for custom column filter rendering. |
RenderFragment<FilterContext<TItem>> | null |
FilterTextAlignment |
Specifies the alignment for column filter cell. If not set, it will fallback to the TextAlignment. |
TextAlignment? | null |
FilterTextDecoration |
Specifies the text decoration for column filter cell. If not set, it will fallback to the TextDecoration. |
TextDecoration? | null |
FilterTextOverflow |
Determines how the text will behave when it is larger than a parent container for column filter cell. If not set, it will fallback to the TextOverflow. |
TextOverflow? | null |
FilterTextSize |
Determines the font size of an element for column filter cell. If not set, it will fallback to the TextSize. |
IFluentTextSize | null |
FilterTextTransform |
Specifies the text transformation for column filter cell. If not set, it will fallback to the TextTransform. |
TextTransform? | null |
FilterTextWeight |
Specifies the text weight for column filter cell. If not set, it will fallback to the TextWeight. |
TextWeight? | null |
FilterVerticalAlignment |
Specifies the vertical alignment for column filter cell. |
VerticalAlignment? | null |
FixedPosition |
Specifies the fixed position of the row cell within the table. Possible values: |
TableColumnFixedPosition | None |
Flex |
Specifies the flex utility of a cell. |
IFluentFlex | null |
Gap |
Specifies the gap utility of a cell. |
IFluentGap | null |
Groupable |
Determines whether the column is eligible to be used as a Group Field. A custom GroupBy function can however be provided. |
bool | false |
Grouping |
Determines whether the column should start grouped. |
bool | false |
GroupTemplate |
Template for custom group. |
RenderFragment<GroupContext<TItem>> | null |
HeaderCellClass |
Custom classname for header cell. |
string | |
HeaderCellStyle |
Custom style for header cell. |
string | |
HeaderDisplay |
Specifies the display behavior of a header cell. |
IFluentDisplay | null |
HeaderFlex |
Specifies the flex utility of a header cell. |
IFluentFlex | null |
HeaderGap |
Specifies the gap utility of a header cell. |
IFluentGap | null |
HeaderGroupCaption |
Defines the caption to be displayed for a group header. If set, all the column headers that are part of the group will be grouped under this caption. |
string | |
HeaderTextAlignment |
Specifies the alignment for column header cell. If not set, it will fallback to the TextAlignment. |
TextAlignment? | null |
HeaderTextDecoration |
Specifies the text decoration for column header cell. If not set, it will fallback to the TextDecoration. |
TextDecoration? | null |
HeaderTextOverflow |
Determines how the text will behave when it is larger than a parent container for column header cell. If not set, it will fallback to the TextOverflow. |
TextOverflow? | null |
HeaderTextSize |
Determines the font size of an element for column header cell. If not set, it will fallback to the TextSize. |
IFluentTextSize | null |
HeaderTextTransform |
Specifies the text transformation for column header cell. If not set, it will fallback to the TextTransform. |
TextTransform? | null |
HeaderTextWeight |
Specifies the text weight for column header cell. If not set, it will fallback to the TextWeight. |
TextWeight? | null |
HeaderVerticalAlignment |
Specifies the vertical alignment for column header cell. |
VerticalAlignment? | null |
HelpText |
Sets the help-text positioned below the field input when editing. |
string | |
MaxVisibleItems |
Specifies how many options should be shown at once. |
int? | null |
Multiple |
Specifies that multiple items can be selected. |
bool | false |
PreventRowClick |
Will set @onclick:StopProgration to true, stopping the RowClick and consequent events from triggering. |
bool | false |
Readonly |
Determines whether end-users are prevented from editing the column's cell values. |
bool | false |
Reorderable |
Specifies a value indicating whether the column can be reordered by the user. |
bool | false |
ReverseSorting |
Determines whether the sort direction will be reversed. |
bool | false |
ShowCaption |
Determines whether the column's caption is displayed within the column header. |
bool | true |
Size |
Size of a select field. |
Size? | null |
Sortable |
Determines whether end-users can sort data by the column's values. |
bool | true |
SortComparer |
Specifies the custom comparer used for sorting the items in this column. Note that this comparer can only be used with in-memory data. |
IComparer<TItem> | null |
SortDirection |
Specifies the column initial sort direction. Possible values: |
SortDirection | default(SortDirection) |
SortDirectionTemplate |
Defines the column's display sort direction template. |
RenderFragment<SortDirectionContext<TItem>> | null |
SortField |
Provides a Sort Field to be used instead by the Sorting mechanism |
string | |
SortOrder |
Specifies the order for sorting when Sorting is set to multiple. |
int | 0 |
Style |
Custom styles. |
string | |
TabIndex |
If defined, indicates that its element can be focused and can participates in sequential keyboard navigation. |
int? | null |
TextAlignment |
Specifies the alignment for the table cell. Possible values: |
TextAlignment | Default |
TextDecoration |
Specifies the text decoration for the table cell. Possible values: |
TextDecoration | Default |
TextOverflow |
Determines how the text will behave when it is larger than a parent container for the table cell. Possible values: |
TextOverflow | Default |
TextSize |
Determines the font size of an element for the table cell. |
IFluentTextSize | null |
TextTransform |
Specifies the text transformation for the table cell. Possible values: |
TextTransform | Default |
TextWeight |
Specifies the text weight for the table cell. Possible values: |
TextWeight | Default |
ValidationPattern |
Forces validation to use regex pattern matching instead of default validator handler. |
string | |
VerticalAlignment |
Specifies the vertical alignment for the table cell. Possible values: |
VerticalAlignment | Default |
Width |
The width of the column. |
IFluentSizing | null |
DataGridDateColumn
| Parameter | Description | Type | Default |
|---|---|---|---|
AggregateCellClass |
Custom classname for the aggregate cell. |
string | |
AggregateCellStyle |
Custom style for the aggregate cell. |
string | |
AggregateDisplay |
Specifies the display behavior of a the aggregate cell. |
IFluentDisplay | null |
AggregateFlex |
Specifies the flex utility of a the aggregate cell. |
IFluentFlex | null |
AggregateGap |
Specifies the gap utility of a the aggregate cell. |
IFluentGap | null |
AggregateTemplate |
Template for aggregate values. |
RenderFragment<AggregateContext<TItem>> | null |
AggregateTextAlignment |
Specifies the alignment for column the aggregate cell. If not set, it will fallback to the TextAlignment. |
TextAlignment? | null |
AggregateTextDecoration |
Specifies the text decoration for column the aggregate cell. If not set, it will fallback to the TextDecoration. |
TextDecoration? | null |
AggregateTextOverflow |
Determines how the text will behave when it is larger than a parent container for column the aggregate cell. If not set, it will fallback to the TextOverflow. |
TextOverflow? | null |
AggregateTextSize |
Determines the font size of an element for column the aggregate cell. If not set, it will fallback to the TextSize. |
IFluentTextSize | null |
AggregateTextTransform |
Specifies the text transformation for column the aggregate cell. If not set, it will fallback to the TextTransform. |
TextTransform? | null |
AggregateTextWeight |
Specifies the text weight for column the aggregate cell. If not set, it will fallback to the TextWeight. |
TextWeight? | null |
AggregateVerticalAlignment |
Specifies the vertical alignment for column the aggregate cell. |
VerticalAlignment? | null |
Caption |
Specifies the column's display caption. |
string | |
CaptionTemplate |
Defines the column's display caption template. |
RenderFragment<DataGridColumn<TItem>> | null |
CellsEditableOnEditCommand |
Allows the cell values to be entered while the grid is in the edit-item state. |
bool | true |
CellsEditableOnNewCommand |
Allows the cell values to be entered while the grid is in the new-item state. |
bool | true |
ChildContent |
Specifies the content to be rendered inside this DataGridDateColumn. |
RenderFragment | null |
CustomFilter |
Custom filter function used to override internal filtering. |
DataGridColumnCustomFilter | null |
DisabledDates |
List of disabled dates that the user should not be able to pick. |
IEnumerable<object> | null |
DisabledDays |
List of disabled days in a week that the user should not be able to pick. |
IEnumerable<DayOfWeek> | null |
DisableMobile |
If enabled, it disables the native input on mobile devices. |
bool | true |
Display |
Specifies the display utility of a cell. |
IFluentDisplay | null |
Displayable |
Determines whether column can be displayed on a grid. |
bool | true |
DisplayFormat |
Specifies the format for display value. |
string | |
DisplayFormatProvider |
Specifies the format provider info for display value. |
IFormatProvider | null |
Displaying |
Specifies the default visibility of the column. This parameter is only used as the initial/default state; runtime visibility is managed by column visibility actions. |
bool | true |
DisplayOrder |
Specifies the initial display order of the column. |
int | 0 |
DisplayTemplate |
Template for custom cell display formatting. |
RenderFragment<CellDisplayContext<TItem>> | null |
Editable |
Determines whether users can edit cell values under this column. |
bool | false |
EditFieldColumnSize |
Specifies the size of an edit field for popup modal and edit form. |
IFluentColumn | null |
EditOrder |
Specifies the initial display order of the column. |
int? | null |
EditTemplate |
Template for custom cell editing. |
RenderFragment<CellEditContext<TItem>> | null |
ElementId |
Specifies the datagrid element id. |
string | |
ExpandTemplate |
Template used to customize self-reference expand rendering. The first regular column that defines this template becomes the self-reference host column. |
RenderFragment<DataGridExpandRowContext<TItem>> | null |
Field |
To bind a column to a data source field, set this property to the required data field name. |
string | |
Filter |
Filter value for this column. |
FilterContext<TItem> | new() |
Filterable |
Determines whether users can filter rows by its cell values. |
bool | true |
FilterCellClass |
Custom classname for filter cell. |
string | |
FilterCellStyle |
Custom style for filter cell. |
string | |
FilterDisplay |
Specifies the display behavior of a filter cell. |
IFluentDisplay | null |
FilterFlex |
Specifies the flex utility of a filter cell. |
IFluentFlex | null |
FilterGap |
Specifies the gap utility of a filter cell. |
IFluentGap | null |
FilterMethod |
Sets the filter method to be used for filtering the column. If null, uses the FilterMethod |
DataGridColumnFilterMethod? | null |
FilterMode |
Gets or sets the filter mode for the column. If set, this overrides the FilterMethod. |
DataGridFilterMode? | null |
FilterTemplate |
Template for custom column filter rendering. |
RenderFragment<FilterContext<TItem>> | null |
FilterTextAlignment |
Specifies the alignment for column filter cell. If not set, it will fallback to the TextAlignment. |
TextAlignment? | null |
FilterTextDecoration |
Specifies the text decoration for column filter cell. If not set, it will fallback to the TextDecoration. |
TextDecoration? | null |
FilterTextOverflow |
Determines how the text will behave when it is larger than a parent container for column filter cell. If not set, it will fallback to the TextOverflow. |
TextOverflow? | null |
FilterTextSize |
Determines the font size of an element for column filter cell. If not set, it will fallback to the TextSize. |
IFluentTextSize | null |
FilterTextTransform |
Specifies the text transformation for column filter cell. If not set, it will fallback to the TextTransform. |
TextTransform? | null |
FilterTextWeight |
Specifies the text weight for column filter cell. If not set, it will fallback to the TextWeight. |
TextWeight? | null |
FilterVerticalAlignment |
Specifies the vertical alignment for column filter cell. |
VerticalAlignment? | null |
FirstDayOfWeek |
Specifies the first day of the week used for date calculations. |
DayOfWeek | DayOfWeek.Monday |
FixedPosition |
Specifies the fixed position of the row cell within the table. Possible values: |
TableColumnFixedPosition | None |
Flex |
Specifies the flex utility of a cell. |
IFluentFlex | null |
Gap |
Specifies the gap utility of a cell. |
IFluentGap | null |
Groupable |
Determines whether the column is eligible to be used as a Group Field. A custom GroupBy function can however be provided. |
bool | false |
Grouping |
Determines whether the column should start grouped. |
bool | false |
GroupTemplate |
Template for custom group. |
RenderFragment<GroupContext<TItem>> | null |
HeaderCellClass |
Custom classname for header cell. |
string | |
HeaderCellStyle |
Custom style for header cell. |
string | |
HeaderDisplay |
Specifies the display behavior of a header cell. |
IFluentDisplay | null |
HeaderFlex |
Specifies the flex utility of a header cell. |
IFluentFlex | null |
HeaderGap |
Specifies the gap utility of a header cell. |
IFluentGap | null |
HeaderGroupCaption |
Defines the caption to be displayed for a group header. If set, all the column headers that are part of the group will be grouped under this caption. |
string | |
HeaderTextAlignment |
Specifies the alignment for column header cell. If not set, it will fallback to the TextAlignment. |
TextAlignment? | null |
HeaderTextDecoration |
Specifies the text decoration for column header cell. If not set, it will fallback to the TextDecoration. |
TextDecoration? | null |
HeaderTextOverflow |
Determines how the text will behave when it is larger than a parent container for column header cell. If not set, it will fallback to the TextOverflow. |
TextOverflow? | null |
HeaderTextSize |
Determines the font size of an element for column header cell. If not set, it will fallback to the TextSize. |
IFluentTextSize | null |
HeaderTextTransform |
Specifies the text transformation for column header cell. If not set, it will fallback to the TextTransform. |
TextTransform? | null |
HeaderTextWeight |
Specifies the text weight for column header cell. If not set, it will fallback to the TextWeight. |
TextWeight? | null |
HeaderVerticalAlignment |
Specifies the vertical alignment for column header cell. |
VerticalAlignment? | null |
HelpText |
Sets the help-text positioned below the field input when editing. |
string | |
Inline |
Display the calendar in an always-open state with the inline option. |
bool | false |
InputFormat |
Specifies the input format mask of the date input. |
string | |
InputMode |
Hints at the type of data that might be entered by the user while editing the element or its contents. Possible values: |
DateInputMode | Date |
Max |
The latest date to accept. |
DateTimeOffset? | null |
Min |
The earliest date to accept. |
DateTimeOffset? | null |
NativeInputMode |
Renders the native based input DateInput instead of the DatePicker. |
bool | false |
PreventRowClick |
Will set @onclick:StopProgration to true, stopping the RowClick and consequent events from triggering. |
bool | false |
Readonly |
Determines whether end-users are prevented from editing the column's cell values. |
bool | false |
Reorderable |
Specifies a value indicating whether the column can be reordered by the user. |
bool | false |
ReverseSorting |
Determines whether the sort direction will be reversed. |
bool | false |
ShowCaption |
Determines whether the column's caption is displayed within the column header. |
bool | true |
Sortable |
Determines whether end-users can sort data by the column's values. |
bool | true |
SortComparer |
Specifies the custom comparer used for sorting the items in this column. Note that this comparer can only be used with in-memory data. |
IComparer<TItem> | null |
SortDirection |
Specifies the column initial sort direction. Possible values: |
SortDirection | default(SortDirection) |
SortDirectionTemplate |
Defines the column's display sort direction template. |
RenderFragment<SortDirectionContext<TItem>> | null |
SortField |
Provides a Sort Field to be used instead by the Sorting mechanism |
string | |
SortOrder |
Specifies the order for sorting when Sorting is set to multiple. |
int | 0 |
StaticPicker |
If enabled, the calendar menu will be positioned as static. |
bool | false |
TextAlignment |
Specifies the alignment for the table cell. Possible values: |
TextAlignment | Default |
TextDecoration |
Specifies the text decoration for the table cell. Possible values: |
TextDecoration | Default |
TextOverflow |
Determines how the text will behave when it is larger than a parent container for the table cell. Possible values: |
TextOverflow | Default |
TextSize |
Determines the font size of an element for the table cell. |
IFluentTextSize | null |
TextTransform |
Specifies the text transformation for the table cell. Possible values: |
TextTransform | Default |
TextWeight |
Specifies the text weight for the table cell. Possible values: |
TextWeight | Default |
TimeAs24hr |
Displays time picker in 24 hour mode without AM/PM selection when enabled. |
bool | false |
ValidationPattern |
Forces validation to use regex pattern matching instead of default validator handler. |
string | |
VerticalAlignment |
Specifies the vertical alignment for the table cell. Possible values: |
VerticalAlignment | Default |
Width |
The width of the column. |
IFluentSizing | null |
DataGridNumericColumn
| Parameter | Description | Type | Default |
|---|---|---|---|
AggregateCellClass |
Custom classname for the aggregate cell. |
string | |
AggregateCellStyle |
Custom style for the aggregate cell. |
string | |
AggregateDisplay |
Specifies the display behavior of a the aggregate cell. |
IFluentDisplay | null |
AggregateFlex |
Specifies the flex utility of a the aggregate cell. |
IFluentFlex | null |
AggregateGap |
Specifies the gap utility of a the aggregate cell. |
IFluentGap | null |
AggregateTemplate |
Template for aggregate values. |
RenderFragment<AggregateContext<TItem>> | null |
AggregateTextAlignment |
Specifies the alignment for column the aggregate cell. If not set, it will fallback to the TextAlignment. |
TextAlignment? | null |
AggregateTextDecoration |
Specifies the text decoration for column the aggregate cell. If not set, it will fallback to the TextDecoration. |
TextDecoration? | null |
AggregateTextOverflow |
Determines how the text will behave when it is larger than a parent container for column the aggregate cell. If not set, it will fallback to the TextOverflow. |
TextOverflow? | null |
AggregateTextSize |
Determines the font size of an element for column the aggregate cell. If not set, it will fallback to the TextSize. |
IFluentTextSize | null |
AggregateTextTransform |
Specifies the text transformation for column the aggregate cell. If not set, it will fallback to the TextTransform. |
TextTransform? | null |
AggregateTextWeight |
Specifies the text weight for column the aggregate cell. If not set, it will fallback to the TextWeight. |
TextWeight? | null |
AggregateVerticalAlignment |
Specifies the vertical alignment for column the aggregate cell. |
VerticalAlignment? | null |
Caption |
Specifies the column's display caption. |
string | |
CaptionTemplate |
Defines the column's display caption template. |
RenderFragment<DataGridColumn<TItem>> | null |
CellsEditableOnEditCommand |
Allows the cell values to be entered while the grid is in the edit-item state. |
bool | true |
CellsEditableOnNewCommand |
Allows the cell values to be entered while the grid is in the new-item state. |
bool | true |
ChildContent |
Specifies the content to be rendered inside this DataGridNumericColumn. |
RenderFragment | null |
Culture |
Helps define the language of an element. Remarkshttps://www.w3schools.com/tags/ref_language_codes.asp |
string | |
CustomFilter |
Custom filter function used to override internal filtering. |
DataGridColumnCustomFilter | null |
Decimals |
Maximum number of decimal places after the decimal separator. |
int | 2 |
DecimalSeparator |
String to use as the decimal separator in numeric values. |
string | "." |
Display |
Specifies the display utility of a cell. |
IFluentDisplay | null |
Displayable |
Determines whether column can be displayed on a grid. |
bool | true |
DisplayFormat |
Specifies the format for display value. |
string | |
DisplayFormatProvider |
Specifies the format provider info for display value. |
IFormatProvider | null |
Displaying |
Specifies the default visibility of the column. This parameter is only used as the initial/default state; runtime visibility is managed by column visibility actions. |
bool | true |
DisplayOrder |
Specifies the initial display order of the column. |
int | 0 |
DisplayTemplate |
Template for custom cell display formatting. |
RenderFragment<CellDisplayContext<TItem>> | null |
Editable |
Determines whether users can edit cell values under this column. |
bool | false |
EditFieldColumnSize |
Specifies the size of an edit field for popup modal and edit form. |
IFluentColumn | null |
EditOrder |
Specifies the initial display order of the column. |
int? | null |
EditTemplate |
Template for custom cell editing. |
RenderFragment<CellEditContext<TItem>> | null |
ElementId |
Specifies the datagrid element id. |
string | |
EnableStep |
If true, enables change of numeric value by pressing on step buttons or by keyboard up/down keys. |
bool? | null |
ExpandTemplate |
Template used to customize self-reference expand rendering. The first regular column that defines this template becomes the self-reference host column. |
RenderFragment<DataGridExpandRowContext<TItem>> | null |
Field |
To bind a column to a data source field, set this property to the required data field name. |
string | |
Filter |
Filter value for this column. |
FilterContext<TItem> | new() |
Filterable |
Determines whether users can filter rows by its cell values. |
bool | true |
FilterCellClass |
Custom classname for filter cell. |
string | |
FilterCellStyle |
Custom style for filter cell. |
string | |
FilterDisplay |
Specifies the display behavior of a filter cell. |
IFluentDisplay | null |
FilterFlex |
Specifies the flex utility of a filter cell. |
IFluentFlex | null |
FilterGap |
Specifies the gap utility of a filter cell. |
IFluentGap | null |
FilterMethod |
Sets the filter method to be used for filtering the column. If null, uses the FilterMethod |
DataGridColumnFilterMethod? | null |
FilterMode |
Gets or sets the filter mode for the column. If set, this overrides the FilterMethod. |
DataGridFilterMode? | null |
FilterTemplate |
Template for custom column filter rendering. |
RenderFragment<FilterContext<TItem>> | null |
FilterTextAlignment |
Specifies the alignment for column filter cell. If not set, it will fallback to the TextAlignment. |
TextAlignment? | null |
FilterTextDecoration |
Specifies the text decoration for column filter cell. If not set, it will fallback to the TextDecoration. |
TextDecoration? | null |
FilterTextOverflow |
Determines how the text will behave when it is larger than a parent container for column filter cell. If not set, it will fallback to the TextOverflow. |
TextOverflow? | null |
FilterTextSize |
Determines the font size of an element for column filter cell. If not set, it will fallback to the TextSize. |
IFluentTextSize | null |
FilterTextTransform |
Specifies the text transformation for column filter cell. If not set, it will fallback to the TextTransform. |
TextTransform? | null |
FilterTextWeight |
Specifies the text weight for column filter cell. If not set, it will fallback to the TextWeight. |
TextWeight? | null |
FilterVerticalAlignment |
Specifies the vertical alignment for column filter cell. |
VerticalAlignment? | null |
FixedPosition |
Specifies the fixed position of the row cell within the table. Possible values: |
TableColumnFixedPosition | None |
Flex |
Specifies the flex utility of a cell. |
IFluentFlex | null |
Gap |
Specifies the gap utility of a cell. |
IFluentGap | null |
Groupable |
Determines whether the column is eligible to be used as a Group Field. A custom GroupBy function can however be provided. |
bool | false |
Grouping |
Determines whether the column should start grouped. |
bool | false |
GroupSeparator |
String to use as the decimal separator in numeric values. |
string | "," |
GroupTemplate |
Template for custom group. |
RenderFragment<GroupContext<TItem>> | null |
HeaderCellClass |
Custom classname for header cell. |
string | |
HeaderCellStyle |
Custom style for header cell. |
string | |
HeaderDisplay |
Specifies the display behavior of a header cell. |
IFluentDisplay | null |
HeaderFlex |
Specifies the flex utility of a header cell. |
IFluentFlex | null |
HeaderGap |
Specifies the gap utility of a header cell. |
IFluentGap | null |
HeaderGroupCaption |
Defines the caption to be displayed for a group header. If set, all the column headers that are part of the group will be grouped under this caption. |
string | |
HeaderTextAlignment |
Specifies the alignment for column header cell. If not set, it will fallback to the TextAlignment. |
TextAlignment? | null |
HeaderTextDecoration |
Specifies the text decoration for column header cell. If not set, it will fallback to the TextDecoration. |
TextDecoration? | null |
HeaderTextOverflow |
Determines how the text will behave when it is larger than a parent container for column header cell. If not set, it will fallback to the TextOverflow. |
TextOverflow? | null |
HeaderTextSize |
Determines the font size of an element for column header cell. If not set, it will fallback to the TextSize. |
IFluentTextSize | null |
HeaderTextTransform |
Specifies the text transformation for column header cell. If not set, it will fallback to the TextTransform. |
TextTransform? | null |
HeaderTextWeight |
Specifies the text weight for column header cell. If not set, it will fallback to the TextWeight. |
TextWeight? | null |
HeaderVerticalAlignment |
Specifies the vertical alignment for column header cell. |
VerticalAlignment? | null |
HelpText |
Sets the help-text positioned below the field input when editing. |
string | |
NativeInputMode |
Renders the native based input NumericInput instead of the NumericPicker. |
bool | false |
PreventRowClick |
Will set @onclick:StopProgration to true, stopping the RowClick and consequent events from triggering. |
bool | false |
Readonly |
Determines whether end-users are prevented from editing the column's cell values. |
bool | false |
Reorderable |
Specifies a value indicating whether the column can be reordered by the user. |
bool | false |
ReverseSorting |
Determines whether the sort direction will be reversed. |
bool | false |
ShowCaption |
Determines whether the column's caption is displayed within the column header. |
bool | true |
ShowStepButtons |
If true, step buttons will be visible. |
bool? | null |
Sortable |
Determines whether end-users can sort data by the column's values. |
bool | true |
SortComparer |
Specifies the custom comparer used for sorting the items in this column. Note that this comparer can only be used with in-memory data. |
IComparer<TItem> | null |
SortDirection |
Specifies the column initial sort direction. Possible values: |
SortDirection | default(SortDirection) |
SortDirectionTemplate |
Defines the column's display sort direction template. |
RenderFragment<SortDirectionContext<TItem>> | null |
SortField |
Provides a Sort Field to be used instead by the Sorting mechanism |
string | |
SortOrder |
Specifies the order for sorting when Sorting is set to multiple. |
int | 0 |
Step |
Specifies the interval between valid values. |
decimal? | null |
TextAlignment |
Specifies the alignment for the table cell. Possible values: |
TextAlignment | Default |
TextDecoration |
Specifies the text decoration for the table cell. Possible values: |
TextDecoration | Default |
TextOverflow |
Determines how the text will behave when it is larger than a parent container for the table cell. Possible values: |
TextOverflow | Default |
TextSize |
Determines the font size of an element for the table cell. |
IFluentTextSize | null |
TextTransform |
Specifies the text transformation for the table cell. Possible values: |
TextTransform | Default |
TextWeight |
Specifies the text weight for the table cell. Possible values: |
TextWeight | Default |
ValidationPattern |
Forces validation to use regex pattern matching instead of default validator handler. |
string | |
VerticalAlignment |
Specifies the vertical alignment for the table cell. Possible values: |
VerticalAlignment | Default |
Width |
The width of the column. |
IFluentSizing | null |
DataGridCheckColumn
| Parameter | Description | Type | Default |
|---|---|---|---|
AggregateCellClass |
Custom classname for the aggregate cell. |
string | |
AggregateCellStyle |
Custom style for the aggregate cell. |
string | |
AggregateDisplay |
Specifies the display behavior of a the aggregate cell. |
IFluentDisplay | null |
AggregateFlex |
Specifies the flex utility of a the aggregate cell. |
IFluentFlex | null |
AggregateGap |
Specifies the gap utility of a the aggregate cell. |
IFluentGap | null |
AggregateTemplate |
Template for aggregate values. |
RenderFragment<AggregateContext<TItem>> | null |
AggregateTextAlignment |
Specifies the alignment for column the aggregate cell. If not set, it will fallback to the TextAlignment. |
TextAlignment? | null |
AggregateTextDecoration |
Specifies the text decoration for column the aggregate cell. If not set, it will fallback to the TextDecoration. |
TextDecoration? | null |
AggregateTextOverflow |
Determines how the text will behave when it is larger than a parent container for column the aggregate cell. If not set, it will fallback to the TextOverflow. |
TextOverflow? | null |
AggregateTextSize |
Determines the font size of an element for column the aggregate cell. If not set, it will fallback to the TextSize. |
IFluentTextSize | null |
AggregateTextTransform |
Specifies the text transformation for column the aggregate cell. If not set, it will fallback to the TextTransform. |
TextTransform? | null |
AggregateTextWeight |
Specifies the text weight for column the aggregate cell. If not set, it will fallback to the TextWeight. |
TextWeight? | null |
AggregateVerticalAlignment |
Specifies the vertical alignment for column the aggregate cell. |
VerticalAlignment? | null |
Caption |
Specifies the column's display caption. |
string | |
CaptionTemplate |
Defines the column's display caption template. |
RenderFragment<DataGridColumn<TItem>> | null |
CellsEditableOnEditCommand |
Allows the cell values to be entered while the grid is in the edit-item state. |
bool | true |
CellsEditableOnNewCommand |
Allows the cell values to be entered while the grid is in the new-item state. |
bool | true |
ChildContent |
Specifies the content to be rendered inside this DataGridCheckColumn. |
RenderFragment | null |
CustomFilter |
Custom filter function used to override internal filtering. |
DataGridColumnCustomFilter | null |
Display |
Specifies the display utility of a cell. |
IFluentDisplay | null |
Displayable |
Determines whether column can be displayed on a grid. |
bool | true |
DisplayFormat |
Specifies the format for display value. |
string | |
DisplayFormatProvider |
Specifies the format provider info for display value. |
IFormatProvider | null |
Displaying |
Specifies the default visibility of the column. This parameter is only used as the initial/default state; runtime visibility is managed by column visibility actions. |
bool | true |
DisplayOrder |
Specifies the initial display order of the column. |
int | 0 |
DisplayTemplate |
Template for custom cell display formatting. |
RenderFragment<CellDisplayContext<TItem>> | null |
Editable |
Determines whether users can edit cell values under this column. |
bool | false |
EditFieldColumnSize |
Specifies the size of an edit field for popup modal and edit form. |
IFluentColumn | null |
EditOrder |
Specifies the initial display order of the column. |
int? | null |
EditTemplate |
Template for custom cell editing. |
RenderFragment<CellEditContext<TItem>> | null |
ElementId |
Specifies the datagrid element id. |
string | |
ExpandTemplate |
Template used to customize self-reference expand rendering. The first regular column that defines this template becomes the self-reference host column. |
RenderFragment<DataGridExpandRowContext<TItem>> | null |
Field |
To bind a column to a data source field, set this property to the required data field name. |
string | |
Filter |
Filter value for this column. |
FilterContext<TItem> | new() |
Filterable |
Determines whether users can filter rows by its cell values. |
bool | true |
FilterCellClass |
Custom classname for filter cell. |
string | |
FilterCellStyle |
Custom style for filter cell. |
string | |
FilterDisplay |
Specifies the display behavior of a filter cell. |
IFluentDisplay | null |
FilterFlex |
Specifies the flex utility of a filter cell. |
IFluentFlex | null |
FilterGap |
Specifies the gap utility of a filter cell. |
IFluentGap | null |
FilterMethod |
Sets the filter method to be used for filtering the column. If null, uses the FilterMethod |
DataGridColumnFilterMethod? | null |
FilterMode |
Gets or sets the filter mode for the column. If set, this overrides the FilterMethod. |
DataGridFilterMode? | null |
FilterTemplate |
Template for custom column filter rendering. |
RenderFragment<FilterContext<TItem>> | null |
FilterTextAlignment |
Specifies the alignment for column filter cell. If not set, it will fallback to the TextAlignment. |
TextAlignment? | null |
FilterTextDecoration |
Specifies the text decoration for column filter cell. If not set, it will fallback to the TextDecoration. |
TextDecoration? | null |
FilterTextOverflow |
Determines how the text will behave when it is larger than a parent container for column filter cell. If not set, it will fallback to the TextOverflow. |
TextOverflow? | null |
FilterTextSize |
Determines the font size of an element for column filter cell. If not set, it will fallback to the TextSize. |
IFluentTextSize | null |
FilterTextTransform |
Specifies the text transformation for column filter cell. If not set, it will fallback to the TextTransform. |
TextTransform? | null |
FilterTextWeight |
Specifies the text weight for column filter cell. If not set, it will fallback to the TextWeight. |
TextWeight? | null |
FilterVerticalAlignment |
Specifies the vertical alignment for column filter cell. |
VerticalAlignment? | null |
FixedPosition |
Specifies the fixed position of the row cell within the table. Possible values: |
TableColumnFixedPosition | None |
Flex |
Specifies the flex utility of a cell. |
IFluentFlex | null |
Gap |
Specifies the gap utility of a cell. |
IFluentGap | null |
Groupable |
Determines whether the column is eligible to be used as a Group Field. A custom GroupBy function can however be provided. |
bool | false |
Grouping |
Determines whether the column should start grouped. |
bool | false |
GroupTemplate |
Template for custom group. |
RenderFragment<GroupContext<TItem>> | null |
HeaderCellClass |
Custom classname for header cell. |
string | |
HeaderCellStyle |
Custom style for header cell. |
string | |
HeaderDisplay |
Specifies the display behavior of a header cell. |
IFluentDisplay | null |
HeaderFlex |
Specifies the flex utility of a header cell. |
IFluentFlex | null |
HeaderGap |
Specifies the gap utility of a header cell. |
IFluentGap | null |
HeaderGroupCaption |
Defines the caption to be displayed for a group header. If set, all the column headers that are part of the group will be grouped under this caption. |
string | |
HeaderTextAlignment |
Specifies the alignment for column header cell. If not set, it will fallback to the TextAlignment. |
TextAlignment? | null |
HeaderTextDecoration |
Specifies the text decoration for column header cell. If not set, it will fallback to the TextDecoration. |
TextDecoration? | null |
HeaderTextOverflow |
Determines how the text will behave when it is larger than a parent container for column header cell. If not set, it will fallback to the TextOverflow. |
TextOverflow? | null |
HeaderTextSize |
Determines the font size of an element for column header cell. If not set, it will fallback to the TextSize. |
IFluentTextSize | null |
HeaderTextTransform |
Specifies the text transformation for column header cell. If not set, it will fallback to the TextTransform. |
TextTransform? | null |
HeaderTextWeight |
Specifies the text weight for column header cell. If not set, it will fallback to the TextWeight. |
TextWeight? | null |
HeaderVerticalAlignment |
Specifies the vertical alignment for column header cell. |
VerticalAlignment? | null |
HelpText |
Sets the help-text positioned below the field input when editing. |
string | |
PreventRowClick |
Will set @onclick:StopProgration to true, stopping the RowClick and consequent events from triggering. |
bool | false |
Readonly |
Determines whether end-users are prevented from editing the column's cell values. |
bool | false |
Reorderable |
Specifies a value indicating whether the column can be reordered by the user. |
bool | false |
ReverseSorting |
Determines whether the sort direction will be reversed. |
bool | false |
ShowCaption |
Determines whether the column's caption is displayed within the column header. |
bool | true |
Sortable |
Determines whether end-users can sort data by the column's values. |
bool | true |
SortComparer |
Specifies the custom comparer used for sorting the items in this column. Note that this comparer can only be used with in-memory data. |
IComparer<TItem> | null |
SortDirection |
Specifies the column initial sort direction. Possible values: |
SortDirection | default(SortDirection) |
SortDirectionTemplate |
Defines the column's display sort direction template. |
RenderFragment<SortDirectionContext<TItem>> | null |
SortField |
Provides a Sort Field to be used instead by the Sorting mechanism |
string | |
SortOrder |
Specifies the order for sorting when Sorting is set to multiple. |
int | 0 |
TextAlignment |
Specifies the alignment for the table cell. Possible values: |
TextAlignment | Default |
TextDecoration |
Specifies the text decoration for the table cell. Possible values: |
TextDecoration | Default |
TextOverflow |
Determines how the text will behave when it is larger than a parent container for the table cell. Possible values: |
TextOverflow | Default |
TextSize |
Determines the font size of an element for the table cell. |
IFluentTextSize | null |
TextTransform |
Specifies the text transformation for the table cell. Possible values: |
TextTransform | Default |
TextWeight |
Specifies the text weight for the table cell. Possible values: |
TextWeight | Default |
ValidationPattern |
Forces validation to use regex pattern matching instead of default validator handler. |
string | |
VerticalAlignment |
Specifies the vertical alignment for the table cell. Possible values: |
VerticalAlignment | Default |
Width |
The width of the column. |
IFluentSizing | null |
DataGridMultiSelectColumn
| Parameter | Description | Type | Default |
|---|---|---|---|
AggregateCellClass |
Custom classname for the aggregate cell. |
string | |
AggregateCellStyle |
Custom style for the aggregate cell. |
string | |
AggregateDisplay |
Specifies the display behavior of a the aggregate cell. |
IFluentDisplay | null |
AggregateFlex |
Specifies the flex utility of a the aggregate cell. |
IFluentFlex | null |
AggregateGap |
Specifies the gap utility of a the aggregate cell. |
IFluentGap | null |
AggregateTemplate |
Template for aggregate values. |
RenderFragment<AggregateContext<TItem>> | null |
AggregateTextAlignment |
Specifies the alignment for column the aggregate cell. If not set, it will fallback to the TextAlignment. |
TextAlignment? | null |
AggregateTextDecoration |
Specifies the text decoration for column the aggregate cell. If not set, it will fallback to the TextDecoration. |
TextDecoration? | null |
AggregateTextOverflow |
Determines how the text will behave when it is larger than a parent container for column the aggregate cell. If not set, it will fallback to the TextOverflow. |
TextOverflow? | null |
AggregateTextSize |
Determines the font size of an element for column the aggregate cell. If not set, it will fallback to the TextSize. |
IFluentTextSize | null |
AggregateTextTransform |
Specifies the text transformation for column the aggregate cell. If not set, it will fallback to the TextTransform. |
TextTransform? | null |
AggregateTextWeight |
Specifies the text weight for column the aggregate cell. If not set, it will fallback to the TextWeight. |
TextWeight? | null |
AggregateVerticalAlignment |
Specifies the vertical alignment for column the aggregate cell. |
VerticalAlignment? | null |
Caption |
Specifies the column's display caption. |
string | |
CaptionTemplate |
Defines the column's display caption template. |
RenderFragment<DataGridColumn<TItem>> | null |
CellsEditableOnEditCommand |
Allows the cell values to be entered while the grid is in the edit-item state. |
bool | true |
CellsEditableOnNewCommand |
Allows the cell values to be entered while the grid is in the new-item state. |
bool | true |
ChildContent |
Specifies the content to be rendered inside this DataGridMultiSelectColumn. |
RenderFragment | null |
CustomFilter |
Custom filter function used to override internal filtering. |
DataGridColumnCustomFilter | null |
Display |
Specifies the display utility of a cell. |
IFluentDisplay | null |
Displayable |
Determines whether column can be displayed on a grid. |
bool | true |
DisplayFormat |
Specifies the format for display value. |
string | |
DisplayFormatProvider |
Specifies the format provider info for display value. |
IFormatProvider | null |
Displaying |
Specifies the default visibility of the column. This parameter is only used as the initial/default state; runtime visibility is managed by column visibility actions. |
bool | true |
DisplayOrder |
Specifies the initial display order of the column. |
int | 0 |
DisplayTemplate |
Template for custom cell display formatting. |
RenderFragment<CellDisplayContext<TItem>> | null |
Editable |
Determines whether users can edit cell values under this column. |
bool | false |
EditFieldColumnSize |
Specifies the size of an edit field for popup modal and edit form. |
IFluentColumn | null |
EditOrder |
Specifies the initial display order of the column. |
int? | null |
EditTemplate |
Template for custom cell editing. |
RenderFragment<CellEditContext<TItem>> | null |
ElementId |
Specifies the datagrid element id. |
string | |
ExpandTemplate |
Template used to customize self-reference expand rendering. The first regular column that defines this template becomes the self-reference host column. |
RenderFragment<DataGridExpandRowContext<TItem>> | null |
Field |
To bind a column to a data source field, set this property to the required data field name. |
string | |
Filter |
Filter value for this column. |
FilterContext<TItem> | new() |
Filterable |
Determines whether users can filter rows by its cell values. |
bool | true |
FilterCellClass |
Custom classname for filter cell. |
string | |
FilterCellStyle |
Custom style for filter cell. |
string | |
FilterDisplay |
Specifies the display behavior of a filter cell. |
IFluentDisplay | null |
FilterFlex |
Specifies the flex utility of a filter cell. |
IFluentFlex | null |
FilterGap |
Specifies the gap utility of a filter cell. |
IFluentGap | null |
FilterMethod |
Sets the filter method to be used for filtering the column. If null, uses the FilterMethod |
DataGridColumnFilterMethod? | null |
FilterMode |
Gets or sets the filter mode for the column. If set, this overrides the FilterMethod. |
DataGridFilterMode? | null |
FilterTemplate |
Template for custom column filter rendering. |
RenderFragment<FilterContext<TItem>> | null |
FilterTextAlignment |
Specifies the alignment for column filter cell. If not set, it will fallback to the TextAlignment. |
TextAlignment? | null |
FilterTextDecoration |
Specifies the text decoration for column filter cell. If not set, it will fallback to the TextDecoration. |
TextDecoration? | null |
FilterTextOverflow |
Determines how the text will behave when it is larger than a parent container for column filter cell. If not set, it will fallback to the TextOverflow. |
TextOverflow? | null |
FilterTextSize |
Determines the font size of an element for column filter cell. If not set, it will fallback to the TextSize. |
IFluentTextSize | null |
FilterTextTransform |
Specifies the text transformation for column filter cell. If not set, it will fallback to the TextTransform. |
TextTransform? | null |
FilterTextWeight |
Specifies the text weight for column filter cell. If not set, it will fallback to the TextWeight. |
TextWeight? | null |
FilterVerticalAlignment |
Specifies the vertical alignment for column filter cell. |
VerticalAlignment? | null |
FixedPosition |
Specifies the fixed position of the row cell within the table. Possible values: |
TableColumnFixedPosition | None |
Flex |
Specifies the flex utility of a cell. |
IFluentFlex | null |
Gap |
Specifies the gap utility of a cell. |
IFluentGap | null |
Groupable |
Determines whether the column is eligible to be used as a Group Field. A custom GroupBy function can however be provided. |
bool | false |
Grouping |
Determines whether the column should start grouped. |
bool | false |
GroupTemplate |
Template for custom group. |
RenderFragment<GroupContext<TItem>> | null |
HeaderCellClass |
Custom classname for header cell. |
string | |
HeaderCellStyle |
Custom style for header cell. |
string | |
HeaderDisplay |
Specifies the display behavior of a header cell. |
IFluentDisplay | null |
HeaderFlex |
Specifies the flex utility of a header cell. |
IFluentFlex | null |
HeaderGap |
Specifies the gap utility of a header cell. |
IFluentGap | null |
HeaderGroupCaption |
Defines the caption to be displayed for a group header. If set, all the column headers that are part of the group will be grouped under this caption. |
string | |
HeaderTextAlignment |
Specifies the alignment for column header cell. If not set, it will fallback to the TextAlignment. |
TextAlignment? | null |
HeaderTextDecoration |
Specifies the text decoration for column header cell. If not set, it will fallback to the TextDecoration. |
TextDecoration? | null |
HeaderTextOverflow |
Determines how the text will behave when it is larger than a parent container for column header cell. If not set, it will fallback to the TextOverflow. |
TextOverflow? | null |
HeaderTextSize |
Determines the font size of an element for column header cell. If not set, it will fallback to the TextSize. |
IFluentTextSize | null |
HeaderTextTransform |
Specifies the text transformation for column header cell. If not set, it will fallback to the TextTransform. |
TextTransform? | null |
HeaderTextWeight |
Specifies the text weight for column header cell. If not set, it will fallback to the TextWeight. |
TextWeight? | null |
HeaderVerticalAlignment |
Specifies the vertical alignment for column header cell. |
VerticalAlignment? | null |
HelpText |
Sets the help-text positioned below the field input when editing. |
string | |
MultiSelectTemplate |
Template to customize multi select checkbox. |
RenderFragment<MultiSelectContext<TItem>> | null |
PreventRowClick |
Will set @onclick:StopProgration to true, stopping the RowClick and consequent events from triggering. |
bool | false |
Readonly |
Determines whether end-users are prevented from editing the column's cell values. |
bool | false |
Reorderable |
Specifies a value indicating whether the column can be reordered by the user. |
bool | false |
ReverseSorting |
Determines whether the sort direction will be reversed. |
bool | false |
ShowCaption |
Determines whether the column's caption is displayed within the column header. |
bool | true |
Sortable |
Determines whether end-users can sort data by the column's values. |
bool | true |
SortComparer |
Specifies the custom comparer used for sorting the items in this column. Note that this comparer can only be used with in-memory data. |
IComparer<TItem> | null |
SortDirection |
Specifies the column initial sort direction. Possible values: |
SortDirection | default(SortDirection) |
SortDirectionTemplate |
Defines the column's display sort direction template. |
RenderFragment<SortDirectionContext<TItem>> | null |
SortField |
Provides a Sort Field to be used instead by the Sorting mechanism |
string | |
SortOrder |
Specifies the order for sorting when Sorting is set to multiple. |
int | 0 |
TextAlignment |
Specifies the alignment for the table cell. Possible values: |
TextAlignment | Default |
TextDecoration |
Specifies the text decoration for the table cell. Possible values: |
TextDecoration | Default |
TextOverflow |
Determines how the text will behave when it is larger than a parent container for the table cell. Possible values: |
TextOverflow | Default |
TextSize |
Determines the font size of an element for the table cell. |
IFluentTextSize | null |
TextTransform |
Specifies the text transformation for the table cell. Possible values: |
TextTransform | Default |
TextWeight |
Specifies the text weight for the table cell. Possible values: |
TextWeight | Default |
ValidationPattern |
Forces validation to use regex pattern matching instead of default validator handler. |
string | |
VerticalAlignment |
Specifies the vertical alignment for the table cell. Possible values: |
VerticalAlignment | Default |
Width |
The width of the column. |
IFluentSizing | null |
DataGridAggregate
| Parameter | Description | Type | Default |
|---|---|---|---|
Aggregate |
Type of aggregate calculation. Possible values: |
DataGridAggregateType | DataGridAggregateType.None |
ChildContent |
Specifies the content to be rendered inside this DataGridAggregate. |
RenderFragment | null |
DisplayFormat |
Specifies the format for display value. |
string | |
DisplayFormatProvider |
Specifies the format provider info for display value. |
IFormatProvider | null |
DisplayTemplate |
Optional display template for aggregate values. |
RenderFragment<AggregateContext<TItem>> | null |
ElementId |
Specifies the datagrid element id. |
string | |
Field |
To bind a column to a data source field, set this property to the required data field name. |
string |
DataGridEditModeOptions
| Parameter | Description | Type | Default |
|---|---|---|---|
CellEditOnDoubleClick |
When the DataGridEditMode is set to Cell configures whether the cell enters edit mode on double click. Defaults to true. |
bool | true |
CellEditOnSingleClick |
When the DataGridEditMode is set to Cell configures whether the cell enters edit mode on single click. Defaults to false. |
bool | false |
CellEditSelectTextOnEdit |
When the DataGridEditMode is set to Cell configures whether the text is selected when the cell enters edit mode. Defaults to false. |
bool | false |
DataGridExpandOptions
| Parameter | Description | Type | Default |
|---|---|---|---|
CollapseIcon |
Defines the collapse icon. |
IconName | DefaultCollapseIcon |
ExpandIcon |
Defines the expand icon. |
IconName | DefaultExpandIcon |
IndentSize |
Defines indentation size in rem. |
double | DefaultIndentSize |
DataGridPagerOptions
| Parameter | Description | Type | Default |
|---|---|---|---|
ButtonRowPosition |
Button Row Position. Possible values: |
PagerElementPosition | PagerElementPosition.Default |
ButtonSize |
Configures the pager buttons size. Possible values: |
Size | Default |
ColumnChooserPosition |
Column Chooser Position. Possible values: |
PagerElementPosition | PagerElementPosition.Default |
PaginationPosition |
Pagination Position. Possible values: |
PagerElementPosition | PagerElementPosition.Default |
TotalItemsPosition |
Total Items Position. Possible values: |
PagerElementPosition | PagerElementPosition.Default |
VirtualizeOptions
| Parameter | Description | Type | Default |
|---|---|---|---|
DataGridHeight |
Sets the DataGrid height when Virtualize feature is enabled (defaults to 500px). |
string | "500px" |
DataGridMaxHeight |
Sets the DataGrid height when Virtualize feature is enabled (defaults to 500px). |
string | "500px" |
OverscanCount |
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. |
int | 10 |
ScrollRowOnEdit |
If DataGrid goes into DataGridEditMode.Inline or DataGridEditMode.Form, scrolls the row to the top. Defaults to true. |
bool | true |
Events
DataGrid
| Event | Description | Type |
|---|---|---|
BatchChange |
Event called after a batch change is made. |
EventCallback<DataGridBatchChangeEventArgs<TItem>> |
BatchEditCellStyling |
Custom handler for the cell styling when the cell has batch edit changes. |
Action<DataGridBatchEditItem<TItem>, DataGridColumn<TItem>, DataGridCellStyling> |
BatchSaved |
Event called after the batch edit is saved. |
EventCallback<DataGridBatchSavedEventArgs<TItem>> |
BatchSaving |
Cancelable event before batch edit is saved. |
EventCallback<DataGridBatchSavingEventArgs<TItem>> |
CellStyling |
Custom handler for the cell styling. Prefer this when provider-specific table CSS overrides row-level styling. |
Action<TItem, DataGridColumn<TItem>, DataGridCellStyling> |
CloneItemCreator |
Function that, if set, is called to clone an instance of the saving item. If left null the built-in DeepClone method will be used. |
Func<TItem, TItem> |
ColumnDisplayingChanged |
Event called after a column display change is made. |
EventCallback<ColumnDisplayChangedEventArgs<TItem>> |
ColumnDisplayOrderChanged |
Event called after a column display order change is made. |
EventCallback<ColumnDisplayOrderChangedEventArgs<TItem>> |
DetailRowTrigger |
A trigger function used to handle the visibility of detail row. |
Func<DetailRowTriggerEventArgs<TItem>, bool> |
EditItemCreator |
Function that, if set, is called to create a instance of the selected item to edit. If left null the selected item will be used. |
Func<TItem, TItem> |
ExpandedRowsChanged |
Occurs after ExpandedRows has changed. |
EventCallback<IList<TItem>> |
ExpandRowTrigger |
A trigger function used to determine whether a row can be expanded in self-reference mode. |
Func<DataGridExpandRowTriggerEventArgs<TItem>, bool> |
FilteredDataChanged |
Raises an event every time that filtered data is refreshed. |
Action<DataGridFilteredDataEventArgs<TItem>> |
GroupBy |
Defines a custom GroupBy function. Groupable needs to be active. If this is defined at the DataGrid level, column grouping will not be considered. |
Func<TItem, object> |
GroupingChanged |
Occurs after grouped columns have changed. |
EventCallback<DataGridGroupingChangedEventArgs<TItem>> |
NewItemCreator |
Function that, if set, is called to create new instance of an item. If left null a default constructor will be used. |
Func<TItem> |
NewItemDefaultSetter |
Function, that is called, when a new item is created for inserting new entry. |
Action<TItem> |
PageChanged |
Occurs after the selected page has changed. |
EventCallback<int> |
PageSizeChanged |
Occurs after the PageSize has changed. |
EventCallback<int> |
PopupClosing |
Occurs before the popup dialog is closed. |
Func<ModalClosingEventArgs, Task> |
ReadChildData |
Event handler used to load children for a self-reference row. |
EventCallback<DataGridReadChildDataEventArgs<TItem>> |
ReadData |
Event handler used to load data manually based on the current page and filter data settings. |
EventCallback<DataGridReadDataEventArgs<TItem>> |
RowBatchEditStyling |
Custom handler for the row that has batch edit changes. |
Action<DataGridBatchEditItem<TItem>, DataGridRowStyling> |
RowClicked |
Event called after the row is clicked. |
EventCallback<DataGridRowMouseEventArgs<TItem>> |
RowCollapsed |
Event called after a self-reference row is collapsed. |
EventCallback<DataGridExpandRowEventArgs<TItem>> |
RowContextMenu |
Event called after the row has requested a context menu. |
EventCallback<DataGridRowMouseEventArgs<TItem>> |
RowDoubleClicked |
Event called after the row is double clicked. |
EventCallback<DataGridRowMouseEventArgs<TItem>> |
RowExpanded |
Event called after a self-reference row is expanded. |
EventCallback<DataGridExpandRowEventArgs<TItem>> |
RowHoverCursor |
Handles the selection of the cursor for a hovered row. If not set, Default will be used. |
Func<TItem, Cursor> |
RowInserted |
Event called after the row is inserted. |
EventCallback<SavedRowItem<TItem, Dictionary<string, object>>> |
RowInserting |
Cancelable event called before the row is inserted. |
EventCallback<CancellableRowChange<TItem, Dictionary<string, object>>> |
RowMouseLeave |
Event called after the mouse leaves the row. |
EventCallback<DataGridRowMouseEventArgs<TItem>> |
RowMouseOver |
Event called after the mouse is over the row. |
EventCallback<DataGridRowMouseEventArgs<TItem>> |
RowRemoved |
Event called after the row is removed. |
EventCallback<TItem> |
RowRemoving |
Cancelable event called before the row is removed. |
EventCallback<CancellableRowChange<TItem>> |
RowSelectable |
Handles the selection of the DataGrid row. If not set it will default to always true. |
Func<RowSelectableEventArgs<TItem>, bool> |
RowStyling |
Custom handler for each row in the datagrid. Applied to the |
Action<TItem, DataGridRowStyling> |
RowUpdated |
Event called after the row is updated. |
EventCallback<SavedRowItem<TItem, Dictionary<string, object>>> |
RowUpdating |
Cancelable event called before the row is updated. |
EventCallback<CancellableRowChange<TItem, Dictionary<string, object>>> |
SelectedCellChanged |
Occurs after the selected cell has changed in the data grid. RemarksThis event is triggered when NavigationMode is set to Cell, indicating that cell-level navigation is enabled. Make sure to handle this event if you need to respond to cell selection changes. |
EventCallback<DataGridCellInfo<TItem>> |
SelectedCellStyling |
Custom handler for the selected cell styling. Prefer this when provider-specific table CSS overrides selected row styling. |
Action<TItem, DataGridColumn<TItem>, DataGridCellStyling> |
SelectedRowChanged |
Occurs after the selected row has changed. |
EventCallback<TItem> |
SelectedRowsChanged |
Occurs after multi selection has changed. |
EventCallback<List<TItem>> |
SelectedRowStyling |
Custom handler for currently selected row. Applied to the |
Action<TItem, DataGridRowStyling> |
SortChanged |
Occurs after the sort direction of a single column has changed. |
EventCallback<DataGridSortChangedEventArgs> |
ValidationItemCreator |
Function that, if set, is called to create a validation instance of an item that it's used as a separate instance for Datagrid's internal processing of validation. If left null, Datagrid will try to use it's own implementation to instantiate. |
Func<TItem> |
DataGridColumn
| Event | Description | Type |
|---|---|---|
AsyncValidator |
Asynchronously validates the input value after trying to save. |
Func<ValidatorEventArgs, CancellationToken, Task> |
CellClass |
Custom classname handler for cell based on the current row item. |
Func<TItem, string> |
CellStyle |
Custom style handler for cell based on the current row item. |
Func<TItem, string> |
GroupBy |
Defines a custom GroupBy function. Groupable needs to be active. |
Func<TItem, object> |
SortOrderChanged |
Raises an event every time that SortOrder is changed. |
EventCallback<int> |
Validator |
Validates the input value after trying to save. |
Action<ValidatorEventArgs> |
DataGridCommandColumn
| Event | Description | Type |
|---|---|---|
AsyncValidator |
Asynchronously validates the input value after trying to save. |
Func<ValidatorEventArgs, CancellationToken, Task> |
CellClass |
Custom classname handler for cell based on the current row item. |
Func<TItem, string> |
CellStyle |
Custom style handler for cell based on the current row item. |
Func<TItem, string> |
GroupBy |
Defines a custom GroupBy function. Groupable needs to be active. |
Func<TItem, object> |
SortOrderChanged |
Raises an event every time that SortOrder is changed. |
EventCallback<int> |
Validator |
Validates the input value after trying to save. |
Action<ValidatorEventArgs> |
DataGridSelectColumn
| Event | Description | Type |
|---|---|---|
AsyncValidator |
Asynchronously validates the input value after trying to save. |
Func<ValidatorEventArgs, CancellationToken, Task> |
CellClass |
Custom classname handler for cell based on the current row item. |
Func<TItem, string> |
CellStyle |
Custom style handler for cell based on the current row item. |
Func<TItem, string> |
GroupBy |
Defines a custom GroupBy function. Groupable needs to be active. |
Func<TItem, object> |
ItemDisabled |
Method used to determine if an item should be disabled. You can unbox the object by using the following example: ItemDisabled="(x) => !((Model)x).Enabled" |
Func<object, bool> |
SortOrderChanged |
Raises an event every time that SortOrder is changed. |
EventCallback<int> |
TextField |
Method used to get the display field from the supplied data source. You can unbox the object by using the following example: TextField="(x) => ((Model)x).Text" |
Func<object, string> |
Validator |
Validates the input value after trying to save. |
Action<ValidatorEventArgs> |
ValueField |
Method used to get the value field from the supplied data source. You can unbox the object by using the following example: ValueField="(x) => ((Model)x).Value" |
Func<object, object> |
DataGridDateColumn
| Event | Description | Type |
|---|---|---|
AsyncValidator |
Asynchronously validates the input value after trying to save. |
Func<ValidatorEventArgs, CancellationToken, Task> |
CellClass |
Custom classname handler for cell based on the current row item. |
Func<TItem, string> |
CellStyle |
Custom style handler for cell based on the current row item. |
Func<TItem, string> |
GroupBy |
Defines a custom GroupBy function. Groupable needs to be active. |
Func<TItem, object> |
SortOrderChanged |
Raises an event every time that SortOrder is changed. |
EventCallback<int> |
Validator |
Validates the input value after trying to save. |
Action<ValidatorEventArgs> |
DataGridNumericColumn
| Event | Description | Type |
|---|---|---|
AsyncValidator |
Asynchronously validates the input value after trying to save. |
Func<ValidatorEventArgs, CancellationToken, Task> |
CellClass |
Custom classname handler for cell based on the current row item. |
Func<TItem, string> |
CellStyle |
Custom style handler for cell based on the current row item. |
Func<TItem, string> |
GroupBy |
Defines a custom GroupBy function. Groupable needs to be active. |
Func<TItem, object> |
SortOrderChanged |
Raises an event every time that SortOrder is changed. |
EventCallback<int> |
Validator |
Validates the input value after trying to save. |
Action<ValidatorEventArgs> |
DataGridCheckColumn
| Event | Description | Type |
|---|---|---|
AsyncValidator |
Asynchronously validates the input value after trying to save. |
Func<ValidatorEventArgs, CancellationToken, Task> |
CellClass |
Custom classname handler for cell based on the current row item. |
Func<TItem, string> |
CellStyle |
Custom style handler for cell based on the current row item. |
Func<TItem, string> |
GroupBy |
Defines a custom GroupBy function. Groupable needs to be active. |
Func<TItem, object> |
SortOrderChanged |
Raises an event every time that SortOrder is changed. |
EventCallback<int> |
Validator |
Validates the input value after trying to save. |
Action<ValidatorEventArgs> |
DataGridMultiSelectColumn
| Event | Description | Type |
|---|---|---|
AsyncValidator |
Asynchronously validates the input value after trying to save. |
Func<ValidatorEventArgs, CancellationToken, Task> |
CellClass |
Custom classname handler for cell based on the current row item. |
Func<TItem, string> |
CellStyle |
Custom style handler for cell based on the current row item. |
Func<TItem, string> |
GroupBy |
Defines a custom GroupBy function. Groupable needs to be active. |
Func<TItem, object> |
SelectionChanged |
Event that is being triggered when the row selection is changed. |
EventCallback<DataGridMultiSelectionChangedEventArgs<TItem>> |
SortOrderChanged |
Raises an event every time that SortOrder is changed. |
EventCallback<int> |
Validator |
Validates the input value after trying to save. |
Action<ValidatorEventArgs> |
DataGridAggregate
| Event | Description | Type |
|---|---|---|
AggregationFunction |
Aggregation calculation. |
Func<IEnumerable<TItem>, DataGridColumn<TItem>, object> |
Methods
DataGrid
| Method | Description | Return | Parameters |
|---|---|---|---|
AddAggregate |
Links the child column with this datagrid. | void | DataGridAggregate<TItem> aggregate |
AddColumn |
Links the child column with this datagrid. | void | DataGridColumn<TItem> column |
AddGroupColumn |
Adds a new column to grouping. | void | DataGridColumn<TItem> column |
ApplySorting |
Applies a new sort to the datagrid using the provided columns, sort order, and sort direction. Replaces the current sorting.
RemarksNote that Sortable and Sortable must be enabled to be able to sort! If more than one column is specified, SortMode must be Multiple | Task | DataGridSortColumnInfo[] columns |
Cancel |
Cancels any edit operation in progress. | Task | |
ClearFilter |
Clears all filters from the grid. | Task | |
ClearFilter |
Clears the corresponding column filters. | Task | string[] fieldNames |
CollapseAllGroups |
Collapses all groups. | Task | |
CollapseAllRows |
Collapses all rows. | Task | |
CollapseGroups |
Collapses the specified groups. For regular single column groups, the group key should be easy to determine, i.e: for a column grouped by Gender the key could be something like : "Male" For complex GroupBy operations, you will need to specify the full group key, i.e: for a group composed of Childrens and Gender, the group key would be something like: "{ Childrens = 1, Gender = M }" GroupedData : DisplayGroupedData | GroupKey: Key | Task | string[] groupKeys |
CollapseRow |
Collapses a row. | Task | TItem item |
Delete |
Deletes the specified item from the Data source. | Task | TItem item |
Edit |
Sets the DataGrid into the Edit state mode for the specified item. | Task | TItem item |
ExpandAllGroups |
Expands all groups. | Task | |
ExpandAllRows |
Expands all rows for the current root view. | Task | |
ExpandGroups |
Expands the specified groups. For regular single column groups, the group key should be easy to determine, i.e: for a column grouped by Gender the key could be something like : "Male" For complex GroupBy operations, you will need to specify the full group key, i.e: for a group composed of Childrens and Gender, the group key would be something like: "{ Childrens = 1, Gender = M }" GroupedData : DisplayGroupedData | GroupKey: Key | Task | string[] groupKeys |
ExpandRow |
Expands a row. | Task | TItem item |
FilterData |
Forces the internal DataGrid data to be filtered.
RemarksKeep in mind that this command will always trigger FilteredDataChanged even though not any data is actually changed. | void | |
GetBatchEditItemByLastEditItem |
Gets the corresponding batch edit item by the last edited item if it exists. | DataGridBatchEditItem<TItem> | TItem item |
GetBatchEditItemByOriginal |
Gets the corresponding batch edit item by the original if it exists. | DataGridBatchEditItem<TItem> | TItem item |
GetColumns |
Returns a list of all the columns that are currently associated with this datagrid. | IReadOnlyList<DataGridColumn<TItem>> | |
GetRowInfo |
No documentation available - no XML comment
RemarksNo documentation available - no XML comment | DataGridRowInfo<TItem> | TItem item |
GetSortByColumns |
Returns a list of all columns currently used to sort this datagrid's data. | IReadOnlyList<DataGridColumn<TItem>> | |
GetState |
Gets the current state of the DataGrid. | Task<DataGridState<TItem>> | |
LoadState |
Loads the state of the DataGrid. | Task | DataGridState<TItem> dataGridState |
New |
Sets the DataGrid into the New state mode. | Task | |
New |
Adds a new item to the DataGrid, either by opening it in edit mode or by adding the batch edit collection, depending on whether batch editing is enabled. | Task | TItem newItem |
Paginate |
Triggers the DataGrid to change data source page.
RemarksValid values are: 1-n: Number of the page. prev: Go to first page. next: Go to next page. first: Go to first page. last: Go to last page. | Task | string paginationCommandOrNumber |
ReadCellEditValue |
Reads the cell value of the current editing item that matches the . | object | string fieldName |
Refresh |
Notifies the DataGrid to refresh. | Task | |
Reload |
Triggers the reload of the DataGrid data. Makes sure not to reload if the DataGrid is in a loading state. | Task | CancellationToken cancellationToken |
RemoveColumn |
Removes an existing link of a child column with this datagrid. Returns: true if item is successfully removed; otherwise, false. | bool | DataGridColumn<TItem> column |
RemoveGroupColumn |
Removes a column from grouping. | void | DataGridColumn<TItem> column |
RemoveRow |
Links the child row with this datagrid. | bool | DataGridRowInfo<TItem> row |
ResetDisplayOrder |
Resets the display order of all columns to their default state.
RemarksThis method sets the internal display order of each column to , effectively clearing any custom display order. If the Columns collection is empty or , the method performs no action. | Task | |
Save |
Save the internal state of the editing items. | Task | |
ScrollToPixels |
If FixedHeader or Virtualize is enabled, it will scroll position to the provided pixels. | ValueTask | int pixels |
ScrollToRow |
If FixedHeader or Virtualize is enabled, it will scroll position to the provided row. | ValueTask | int row |
Select |
Selects the specified item. | Task | TItem item |
SetLoading |
Sets the DataGrid into the loading state. Makes sure to invoke the StateHasChanged method. | void | bool isLoading |
Sort |
Sorts the Data for the specified column. Note that Sortable must be enabled to be able to sort! | Task | DataGridColumn<TItem> column, SortDirection? sortDirection |
Sort |
Sorts the Data for the specified column. Note that Sortable must be enabled to be able to sort! | Task | string fieldName, SortDirection? sortDirection |
ToggleDetailRow |
Toggles DetailRow while evaluating the DetailRowTrigger if provided. Use to ignore DetailRowTrigger and toggle the DetailRow. | Task | TItem item, bool forceDetailRow |
ToggleGroups |
Toggles the specified groups. For regular single column groups, the group key should be easy to determine, i.e: for a column grouped by Gender the key could be something like : "Male" For complex GroupBy operations, you will need to specify the full group key, i.e: for a group composed of Childrens and Gender, the group key would be something like: "{ Childrens = 1, Gender = M }" GroupedData : DisplayGroupedData | GroupKey: Key | Task | string[] groupKeys |
ToggleRow |
Toggles a row. | Task | TItem item |
UpdateCellEditValue |
Updates the cell of the current editing item that matches the . | void | string fieldName, object value |
ValidateAll |
Validates the current edit operation. | Task<bool> |
DataGridColumn
| Method | Description | Return | Parameters |
|---|---|---|---|
CellValuesAreEditable |
Indicates whether the cell values are editable. | bool | |
GetDisplayOrder |
Gets the display order of the column, based on the internal display order if set, otherwise falls back to the DisplayOrder property. | int | |
SetDisplayOrder |
No documentation available - no XML comment
RemarksNo documentation available - no XML comment | Task | int displayOrder, bool forceParentRefresh |
SetDisplaying |
Sets whether the column is displaying. | Task | bool displaying |
FormatDisplayValue |
Gets the formatted display value. | string | object value |
DataGridCommandColumn
| Method | Description | Return | Parameters |
|---|---|---|---|
CellValuesAreEditable |
Indicates whether the cell values are editable. | bool | |
GetDisplayOrder |
Gets the display order of the column, based on the internal display order if set, otherwise falls back to the DisplayOrder property. | int | |
SetDisplayOrder |
No documentation available - no XML comment
RemarksNo documentation available - no XML comment | Task | int displayOrder, bool forceParentRefresh |
SetDisplaying |
Sets whether the column is displaying. | Task | bool displaying |
FormatDisplayValue |
Gets the formatted display value. | string | object value |
DataGridSelectColumn
| Method | Description | Return | Parameters |
|---|---|---|---|
CellValuesAreEditable |
Indicates whether the cell values are editable. | bool | |
GetDisplayOrder |
Gets the display order of the column, based on the internal display order if set, otherwise falls back to the DisplayOrder property. | int | |
SetDisplayOrder |
No documentation available - no XML comment
RemarksNo documentation available - no XML comment | Task | int displayOrder, bool forceParentRefresh |
SetDisplaying |
Sets whether the column is displaying. | Task | bool displaying |
FormatDisplayValue |
Gets the formatted display value. | string | object value |
DataGridDateColumn
| Method | Description | Return | Parameters |
|---|---|---|---|
CellValuesAreEditable |
Indicates whether the cell values are editable. | bool | |
GetDisplayOrder |
Gets the display order of the column, based on the internal display order if set, otherwise falls back to the DisplayOrder property. | int | |
SetDisplayOrder |
No documentation available - no XML comment
RemarksNo documentation available - no XML comment | Task | int displayOrder, bool forceParentRefresh |
SetDisplaying |
Sets whether the column is displaying. | Task | bool displaying |
FormatDisplayValue |
Gets the formatted display value. | string | object value |
DataGridNumericColumn
| Method | Description | Return | Parameters |
|---|---|---|---|
CellValuesAreEditable |
Indicates whether the cell values are editable. | bool | |
GetDisplayOrder |
Gets the display order of the column, based on the internal display order if set, otherwise falls back to the DisplayOrder property. | int | |
SetDisplayOrder |
No documentation available - no XML comment
RemarksNo documentation available - no XML comment | Task | int displayOrder, bool forceParentRefresh |
SetDisplaying |
Sets whether the column is displaying. | Task | bool displaying |
FormatDisplayValue |
Gets the formatted display value. | string | object value |
DataGridCheckColumn
| Method | Description | Return | Parameters |
|---|---|---|---|
CellValuesAreEditable |
Indicates whether the cell values are editable. | bool | |
GetDisplayOrder |
Gets the display order of the column, based on the internal display order if set, otherwise falls back to the DisplayOrder property. | int | |
SetDisplayOrder |
No documentation available - no XML comment
RemarksNo documentation available - no XML comment | Task | int displayOrder, bool forceParentRefresh |
SetDisplaying |
Sets whether the column is displaying. | Task | bool displaying |
FormatDisplayValue |
Gets the formatted display value. | string | object value |
DataGridMultiSelectColumn
| Method | Description | Return | Parameters |
|---|---|---|---|
CellValuesAreEditable |
Indicates whether the cell values are editable. | bool | |
GetDisplayOrder |
Gets the display order of the column, based on the internal display order if set, otherwise falls back to the DisplayOrder property. | int | |
SetDisplayOrder |
No documentation available - no XML comment
RemarksNo documentation available - no XML comment | Task | int displayOrder, bool forceParentRefresh |
SetDisplaying |
Sets whether the column is displaying. | Task | bool displaying |
FormatDisplayValue |
Gets the formatted display value. | string | object value |
DataGridAggregate
| Method | Description | Return | Parameters |
|---|---|---|---|
Average |
Average value of numeric value. | object | IEnumerable<TItem> Data, DataGridColumn<TItem> column |
Count |
Count all values that are not null. | object | IEnumerable<TItem> Data, DataGridColumn<TItem> column |
FalseCount |
Count all boolean values that are false. | object | IEnumerable<TItem> Data, DataGridColumn<TItem> column |
Max |
Max value of numeric value. | object | IEnumerable<TItem> Data, DataGridColumn<TItem> column |
Min |
Min value of numeric value. | object | IEnumerable<TItem> Data, DataGridColumn<TItem> column |
Sum |
Summary of numeric value. | object | IEnumerable<TItem> Data, DataGridColumn<TItem> column |
TrueCount |
Count all boolean values that are true. | object | IEnumerable<TItem> Data, DataGridColumn<TItem> column |