Skip to main content

IGrid Properties

An interface that defines the DxGrid component’s API members (properties and methods).
Name Description
AllowColumnReorder Specifies whether users can reorder columns.
AllowDragRows Specifies whether users can start the row drag operation.
AllowedDropTarget Specifies allowed drag-and-drop targets.
AllowGroup Specifies whether users can group grid data.
AllowSelectRowByClick Specifies whether users can select and deselect rows by mouse clicks.
AllowSort Specifies whether users can sort grid data.
Attributes Specifies a collection of standard HTML attributes applied to the Grid.
AutoCollapseDetailRow Specifies whether an expanded detail row should be automatically collapsed when a user expands another detail row.
AutoExpandAllGroupRows Specifies whether to expand all group rows automatically when the grid loads data or users interact with the grid.
ColumnCaptionAlignment Specifies the alignment of all column captions.
ColumnFooterTemplate Specifies a common template used to display all footer cells in the Grid.
ColumnGroupFooterTemplate Specifies a common template used to display all column’s group footers in the Grid.
ColumnHeaderCaptionTemplate Specifies a common template used to display captions of all column headers in the Grid.
ColumnResizeMode Specifies whether and how users can resize Grid columns.
CssClass Assigns a CSS class to the Grid.
CustomValidators Allows you to declare custom validator components.
Data Specifies an object that supplies Grid data.
DataColumnCellDisplayTemplate Specifies a common template used to display all data column cells in the Grid.
DataColumnCellEditTemplate Allows you to replace automatically generated editors with custom content in all edit cells displayed for data columns.
DataColumnFilterMenuTemplate Specifies a common template used to display all column filter menus in the Grid.
DataColumnFilterRowCellTemplate Specifies a common template used to display all filter row cells in the Grid data columns.
DataColumnGroupRowTemplate Specifies a common template used to display all group rows in the Grid.
DetailExpandButtonDisplayMode Specifies when to display master-detail expand buttons.
DetailRowDisplayMode Specifies when to display detail rows in the Grid.
DetailRowTemplate Specifies a template used to display a detail row.
DragHintTextTemplate Specifies the template for the drag hint.
DropTargetMode Specifies the drop position behavior. Applicable only to drag and drop operations initiated externally.
EditFormButtonsVisible Specifies whether the edit form contains the predefined Save and Cancel buttons.
EditFormTemplate Specifies the template used to display the edit form.
EditMode Specifies how users edit Grid data.
EditNewRowPosition Specifies the position of UI elements used to create new rows.
EditorRenderMode Specifies how the Grid renders editors in the filter row and in data rows during edit operations.
EmptyDataAreaTemplate Specifies the template used to display an empty data area.
FilterMenuButtonDisplayMode Specifies when the Grid displays filter menu buttons in column headers.
FocusedRowEnabled Specifies whether the row focus is enabled.
FooterDisplayMode Specifies when to display the footer in the Grid.
GroupFooterDisplayMode Specifies when to display group footers in the Grid.
HighlightRowOnHover Specifies whether to highlight a data row when a user hovers the mouse pointer over it.
KeyboardNavigationEnabled Obsolete. 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.
KeyFieldName Specifies the name of a data field that contains unique identifiers for Grid data items.
KeyFieldNames Specifies the names of data fields that contain key values. The combination of key values forms a unique identifier for a Grid data item.
PageIndex Specifies the grid’s active page index.
PagerAutoHideNavButtons Specifies whether arrow navigation buttons are hidden when all numeric buttons are displayed in the pager.
PagerNavigationMode Specifies how users navigate between Grid pages.
PagerPosition Specifies the pager position.
PagerSwitchToInputBoxButtonCount Specifies the number of pages when the pager switches from numeric buttons to the input box in Auto mode.
PagerVisible Specifies whether the Grid displays the pager.
PagerVisibleNumericButtonCount Specifies the maximum number of numeric buttons displayed in the pager.
PageSize Specifies the maximum number of rows that the grid can display on a page.
PageSizeSelectorAllRowsItemVisible Specifies whether the page size selector contains the All item.
PageSizeSelectorItems Specifies items available in the page size selector.
PageSizeSelectorVisible Specifies whether the Grid displays the page size selector in the pager.
PopupEditFormCssClass Assigns a CSS class to the pop-up edit form.
PopupEditFormHeaderText Specifies text displayed in the pop-up edit form’s header.
SearchBoxInputDelay Specifies the time interval between the last typed character in the search box and the consequent search text update.
SearchBoxNullText Specifies the prompt text displayed in the search box when it is empty.
SearchBoxTemplate Specifies a template for the search box.
SearchText Specifies the text that the Grid uses to filter and highlight data.
SearchTextParseMode Specifies how the grid treats search words.
SelectAllCheckboxMode Specifies whether the Select All checkbox selects all rows on the current page or on all grid pages.
SelectedDataItem In single selection mode, specifies the data item that corresponds to the selected Grid row.
SelectedDataItems In multiple selection mode, specifies data items that correspond to selected Grid rows.
SelectionMode Specifies selection mode.
ShowAllRows Specifies whether the Grid displays all rows on one page.
ShowFilterRow Specifies whether the Grid displays the filter row.
ShowGroupedColumns Specifies whether to display grouped columns among other columns in the grid’s data area.
ShowGroupPanel Specifies whether to show the Group Panel.
ShowSearchBox Specifies whether the Grid displays the search box.
SizeMode Specifies the size of grid elements (for instance, text size and row height) and other components that are built-in to the grid (for instance, pager and buttons).
SkeletonRowsEnabled Specifies whether the Grid displays skeletons on row loading.
TextWrapEnabled Specifies whether the Grid wraps words or trims extra words and displays an ellipsis.
ToolbarTemplate Specifies a template for a toolbar area.
ValidationEnabled Specifies whether the Grid validates user input in DevExpress data editors located in the edit form or edit cells.
VirtualScrollingEnabled Specifies whether vertical virtual scrolling is enabled.
See Also