Back to Devexpress

DxGrid Properties

blazor-devexpress-dot-blazor-dot-dxgrid-dot-underscore-properties.md

latest13.9 KB
Original Source

DxGrid Properties

A component that displays data in a tabular format and allows users to edit, sort, group, filter, and otherwise shape data.

NameDescription
AllowColumnReorderSpecifies whether users can reorder columns.
AllowDragRowsSpecifies whether users can start the row drag operation.
AllowedDropTargetSpecifies allowed drag-and-drop targets.
AllowGroupSpecifies whether users can group grid data.
AllowSelectRowByClickSpecifies whether users can select and deselect rows by mouse clicks, tap gestures, and keyboard shortcuts.
AllowSortSpecifies whether users can sort grid data.
AttributesSpecifies a collection of standard HTML attributes applied to the Grid.
AutoCollapseDetailRowSpecifies whether an expanded detail row should be automatically collapsed when a user expands another detail row.
AutoExpandAllGroupRowsSpecifies whether to expand all group rows automatically when the grid loads data or users interact with the grid.
ColumnCaptionAlignmentSpecifies the alignment of all column captions.
ColumnFooterTemplateSpecifies a common template used to display all footer cells in the Grid.
ColumnGroupFooterTemplateSpecifies a common template for all group footer cells in the Grid.
ColumnHeaderCaptionTemplateSpecifies a common template used to display captions of all column headers in the Grid.
ColumnResizeModeSpecifies whether and how users can resize Grid columns.
ColumnsAllows you to add Grid columns.
ContextMenusSpecifies available context menus.
CssClassAssigns a CSS class to the Grid.
CustomValidatorsAllows you to declare custom validator components.
DataSpecifies an object that supplies Grid data.
DataColumnCellDisplayTemplateSpecifies a common template used to display all data column cells in the Grid.
DataColumnCellEditTemplateAllows you to replace automatically generated editors with custom content in all edit cells displayed for data columns.
DataColumnFilterMenuTemplateSpecifies a common template used to display all column filter menus in the Grid.
DataColumnFilterRowCellTemplateAllows you to replace automatically generated editors with custom content in all filter row cells displayed for data columns.
DataColumnGroupRowTemplateSpecifies a common template used to display all group rows in the Grid.
DetailExpandButtonDisplayModeSpecifies when to display master-detail expand buttons.
DetailRowDisplayModeSpecifies when to display detail rows in the Grid.
DetailRowTemplateSpecifies a template used to display a detail row.
DragHintTextTemplateSpecifies the template for the drag hint.
DropTargetModeSpecifies the drop position behavior. Applicable only to drag and drop operations initiated externally.
EditFormButtonsVisibleSpecifies whether the edit form contains the predefined Save and Cancel buttons.
EditFormTemplateSpecifies the template used to display the edit form.
EditModeSpecifies how users edit Grid data.
EditNewRowPositionSpecifies the position of UI elements used to create new rows.
EditOnKeyPressIn EditCell mode, specifies whether cell editing starts once a user begins typing a new value.
EditorRenderModeSpecifies how the Grid renders editors in the filter row and in data rows during edit operations.
EmptyDataAreaTemplateSpecifies the template used to display an empty data area.
EnterKeyDirectionIn EditCell mode, specifies where focus moves after a user presses Enter.
FilterBuilderTemplateSpecifies a template for the filter builder.
FilterMenuButtonDisplayModeSpecifies when the Grid displays filter menu buttons in column headers.
FilterPanelDisplayModeSpecifies the filter panel visibility.
FocusedRowEnabledSpecifies whether the row focus is enabled.
FooterDisplayModeSpecifies when to display the footer in the Grid.
GroupFooterDisplayModeSpecifies when to display group footers in the Grid.
GroupSummaryContains group summary items.
HighlightRowOnHoverSpecifies whether to highlight a data row when a user hovers the mouse pointer over it.
KeyboardNavigationEnabledObsolete. This property is now obsolete because the Grid component activates keyboard navigation and built-in shortcuts by default. Do not use this property in your project.
KeyFieldNameSpecifies the name of a data field that contains unique identifiers for Grid data items.
KeyFieldNamesSpecifies the names of data fields that contain key values. The combination of key values forms a unique identifier for a Grid data item.
PageIndexSpecifies the active page index.
PagerAutoHideNavButtonsSpecifies whether arrow navigation buttons are hidden when all numeric buttons are displayed in the pager.
PagerNavigationModeSpecifies how users navigate between Grid pages.
PagerPositionSpecifies the pager position.
PagerSwitchToInputBoxButtonCountSpecifies the number of pages when the pager switches from numeric buttons to the input box in Auto mode.
PagerVisibleSpecifies whether the Grid displays the pager.
PagerVisibleNumericButtonCountSpecifies the maximum number of numeric buttons displayed in the pager.
PageSizeSpecifies the maximum number of rows displayed on a page.
PageSizeSelectorAllRowsItemVisibleSpecifies whether the page size selector contains the All item.
PageSizeSelectorItemsSpecifies items available in the page size selector.
PageSizeSelectorVisibleSpecifies whether the Grid displays the page size selector in the pager.
PopupEditFormCssClassAssigns a CSS class to the pop-up edit form.
PopupEditFormHeaderTextSpecifies text displayed in the pop-up edit form’s header.
SearchBoxInputDelaySpecifies the time interval between the last typed character in the search box and the consequent search text update.
SearchBoxNullTextSpecifies the prompt text displayed in the search box when it is empty.
SearchBoxTemplateSpecifies a template for the search box.
SearchTextSpecifies the text that the Grid uses to filter and highlight data.
SearchTextParseModeSpecifies how the grid treats search words.
SelectAllCheckboxModeSpecifies whether the Select All checkbox selects all rows on the current page or on all grid pages.
SelectedDataItemIn single selection mode, this property specifies the data item that corresponds to the selected Grid row.
SelectedDataItemsIn multiple selection mode, this property specifies data items that corresponds to selected Grid rows.
SelectionModeSpecifies selection mode.
ShowAllRowsSpecifies whether the Grid displays all rows on one page. To avoid performance issues when the Grid is bound to a large data source, use the VirtualScrollingEnabled property instead.
ShowFilterRowSpecifies whether the Grid displays the filter row.
ShowGroupedColumnsSpecifies whether to display grouped columns with other columns in the grid’s data area.
ShowGroupPanelSpecifies whether to show the Group Panel.
ShowSearchBoxSpecifies whether the Grid displays the search box.
SizeModeSpecifies the size of grid elements (for instance, text size and row height) and other built-in grid components (for instance, pager and buttons).
SkeletonRowsEnabledSpecifies whether the Grid displays skeletons while it loads data.
TextWrapEnabledSpecifies whether the Grid wraps words or trims extra words and displays an ellipsis.
ToolbarTemplateSpecifies a template for a toolbar area.
TotalSummaryContains total summary items.
ValidationEnabledSpecifies whether the Grid validates user input in DevExpress data editors located in the edit form or edit cells.
VirtualScrollingEnabledSpecifies whether virtual scrolling is enabled.
VirtualScrollingModeWhen VirtualScrollingEnabled is set to true, specifies whether the Grid virtualizes rows, columns, or both.

See Also

DxGrid Class

DxGrid Members

DevExpress.Blazor Namespace