Skip to main content

DxGrid Members

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

Constructors

Name Description
DxGrid() Initializes a new instance of the DxGrid class.

Properties

Name Description
AllowColumnReorder Specifies whether users can reorder columns.
AllowGroup Specifies whether users can group grid data.
AllowSelectRowByClick Specifies whether users can select and deselect rows by mouse clicks, tap gestures, and keyboard shortcuts.
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 for all group footer cells 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.
Columns Allows you to add Grid columns.
CssClass Specifies the name of a CSS class applied 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 Allows you to replace automatically generated editors with custom content in all filter row cells displayed for 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.
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 the edit form 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.
GroupSummary Contains group summary items.
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 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 displayed 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 Specifies the name of the CSS class applied 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, this property specifies the data item that corresponds to the selected Grid row.
SelectedDataItems In multiple selection mode, this property specifies data items that corresponds 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 with 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 built-in grid components (for instance, pager and buttons).
SkeletonRowsEnabled Specifies whether the Grid displays skeleton rows while it loads data.
TextWrapEnabled Specifies whether the Grid wraps words or trims extra words and displays an ellipsis.
ToolbarTemplate Specifies a template for a toolbar area.
TotalSummary Contains total summary items.
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.

Methods

Name Description
AutoFitColumnWidths() Adjusts column widths to their content.
AutoFitColumnWidths(Boolean) Obsolete. Automatically adjusts column widths to their content.
BeginUpdate() Suspends Grid updates caused by parameter changes and method calls until the EndUpdate() method is called.
CancelEditAsync() Cancels row editing and discards changes.
ClearFilter() Clears the filter applied to grid data.
ClearSelection() Clears selection.
ClearSort() Clears sorting.
CollapseAllDetailRows() Collapses all detail rows.
CollapseAllGroupRows() Collapses all group rows.
CollapseDetailRow(Int32) Collapses the specified detail row.
CollapseGroupRow(Int32, Boolean) Collapses a group row with the specified visible index.
DeselectAllAsync() Deselects all rows in the grid.
DeselectAllOnPage() Deselects all rows on the current visible page.
DeselectDataItem(Object) Deselects a row that corresponds to the specified data item.
DeselectDataItems(IEnumerable<Object>) Deselects rows that correspond to the specified data items.
DeselectRow(Int32) Deselects a row with the specified visible index.
DeselectRows(IEnumerable<Int32>) Deselects rows with the specified visible indexes.
EndUpdate() Resumes Grid updates (when the BeginUpdate() method pauses updates) and re-renders the Grid.
Equals(Object, Object) static Determines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object) Determines whether the specified object is equal to the current object. Inherited from Object.
ExpandAllGroupRows() Expands all group rows.
ExpandDetailRow(Int32) Expands the specified detail row.
ExpandGroupRow(Int32, Boolean) Expands a group row with the specified visible index.
ExportToCsvAsync(Stream, GridCsvExportOptions) Exports grid data to a stream in CSV format.
ExportToCsvAsync(String, GridCsvExportOptions) Exports grid data in CSV format and downloads the resulting file to the client machine.
ExportToXlsAsync(Stream, GridXlExportOptions) Exports grid data to a stream in XLS format.
ExportToXlsAsync(String, GridXlExportOptions) Exports grid data in XLS format and downloads the resulting file to the client machine.
ExportToXlsxAsync(Stream, GridXlExportOptions) Exports grid data in XLSX format to a stream.
ExportToXlsxAsync(String, GridXlExportOptions) Exports grid data in XLSX format and downloads the resulting file to the client machine.
FilterBy(String, GridFilterRowOperatorType, Object) Filters grid data by the specified column value.
GetColumnEditSettings<T>(String) Returns editor settings of the column bound to the specified data source field.
GetColumns() Returns a collection of all grid columns.
GetDataColumns() Returns a data column collection.
GetDataItem(Int32) Gets a data source item that is bound to the processed row.
GetDataItemValue(Object, String) Returns the value of the specified field for the specified data item.
GetEditContext() Returns the edit context.
GetFieldFilterCriteria(String) Returns the filter criteria applied to the specified field of the bound data source.
GetFilterCriteria() Returns the filter criteria applied to the grid data.
GetFocusedDataItem() Returns a data item bound to the focused data row.
GetFocusedRowIndex() Returns the visible index of the focused row.
GetGroupCount() Gets the number of grouped columns.
GetGroupSummaryDisplayText(IGridSummaryItem, Int32) Gets a group summary item’s display text.
GetGroupSummaryFormattedValue(IGridSummaryItem, Int32) Gets a group summary item’s formatted value.
GetGroupSummaryItems() Gets the collection of group summary items.
GetGroupSummaryLabel(IGridSummaryItem, Int32) Gets the name of a group summary‘s function name.
GetGroupSummaryValue(IGridSummaryItem, Int32) Gets a group summary item’s value.
GetHashCode() Serves as the default hash function. Inherited from Object.
GetPageCount() Returns the total number of pages in the Grid.
GetRowLevel(Int32) Gets the nesting level of the processed row.
GetRowValue(Int32, String) Gets the value of the data source field in the specified row.
GetSortedColumns() Gets the collection of sorted columns.
GetStartRowVisibleIndex() Gets the visible index of the first row on the current page.
GetTotalSummaryDisplayText(IGridSummaryItem) Gets a total summary item’s display text.
GetTotalSummaryFormattedValue(IGridSummaryItem) Gets a total summary item’s formatted value.
GetTotalSummaryItems() Gets the collection of total summary items.
GetTotalSummaryLabel(IGridSummaryItem) Gets the name of a total summary‘s function name.
GetTotalSummaryValue(IGridSummaryItem) Gets a total summary item’s value.
GetType() Gets the Type of the current instance. Inherited from Object.
GetVisibleColumns() Returns a collection of visible columns sorted based on their display order.
GetVisibleRowCount() Gets the total number of visible rows in the grid.
GroupBy(String, Int32) Groups data by values of the specified column and inserts the grouped column in the specified position between other grouped columns.
GroupBy(String) Groups data by values of the specified column.
IsDataItemFocused(Object) Identifies whether the row bound to the specified data item is focused.
IsDataItemSelected(Object) Returns whether the row that corresponds to the specified data item is selected.
IsDetailRowExpanded(Int32) Indicates whether the specified detail row is expanded.
IsEditing() Returns whether the Grid is being edited.
IsEditingNewRow() Returns whether a new Grid row is being edited.
IsEditingRow(Int32) Returns whether the specified Grid row is being edited.
IsGroupRow(Int32) Specifies whether the specified row is a group row.
IsGroupRowExpanded(Int32) Specifies whether the specified group row is expanded.
IsRowFocused(Int32) Identifies whether the row with the specified visible index is focused.
IsRowSelected(Int32) Returns whether the specified row is selected.
LoadLayout(GridPersistentLayout) Restores the DxGrid layout.
MakeDataItemVisibleAsync(Object) Makes the row bound to the specified data item visible on screen.
MakeRowVisible(Int32) Makes the row with the specified visible index visible on screen.
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
RefreshSummary() Refreshes all total and group summary values in the grid.
Reload() Reloads Grid data.
SaveChangesAsync() Triggers validation and raises the EditModelSaving event if validation succeeds. The method immediately raises this event if validation is disabled.
SaveLayout() Saves information about the DxGrid‘s layout.
SelectAllAsync(Boolean) Selects or deselects all rows in the grid.
SelectAllOnPage(Boolean) Selects or deselects all rows on the current visible page.
SelectDataItem(Object, Boolean) Selects or deselects a row that corresponds to the specified data item.
SelectDataItems(IEnumerable<Object>, Boolean) Selects or deselects rows that correspond to the specified data items.
SelectRow(Int32, Boolean) Selects or deselects a row with the specified visible index.
SelectRows(IEnumerable<Int32>, Boolean) Selects or deselects rows with the specified visible indexes.
SetFieldFilterCriteria(String, CriteriaOperator) Applies a filter to the specified data field.
SetFilterCriteria(CriteriaOperator) Applies a filter to grid data.
SetFocusedDataItemAsync(Object) Moves focus to the row bound to the specified data item.
SetFocusedRowIndex(Int32) Moves focus to the row with the specified visible index.
ShowColumnChooser() Shows the column chooser in the center of the grid.
ShowColumnChooser(DialogDisplayOptions) Shows the column chooser and positions it based on the specified display options.
ShowColumnChooser(String) Shows the column chooser below the specified target element.
ShowDataItemDeleteConfirmation(Object) Displays the delete confirmation dialog for the specified data item. If a user confirms the operation, the method raises the DataItemDeleting event.
ShowRowDeleteConfirmation(Int32) Displays the delete confirmation dialog for the specified row. If a user confirms the operation, the method raises the DataItemDeleting event.
SortBy(String, GridColumnSortOrder, Int32) Sorts data by column values in the specified order, and specifies the sorted column’s index.
SortBy(String, GridColumnSortOrder) Sorts data by column values in the specified order.
SortBy(String) Sorts data by the specified column values.
StartEditDataItemAsync(Object, String) Starts editing the specified data item.
StartEditNewRowAsync(String) Starts editing a new row.
StartEditRowAsync(Int32, String) Starts editing the row with the specified visible index.
ToString() Returns a string that represents the current object. Inherited from Object.
WaitForDataLoadAsync() Returns a task that completes when pending asynchronous data load operations are completed.
WaitForInstantFeedbackRowLoadAsync(Int32) Obsolete. Returns a task that is completed when the specified row of an asynchronous Instant Feedback Data Source is loaded.
WaitForRemoteSourceRowLoadAsync(Int32) Returns a task that is completed when the specified row of an asynchronous remote data source is loaded.

Events

Name Description
CustomGroup Enables you to implement custom logic used to group data in the grid.
CustomizeCellDisplayText Allows you to customize text displayed within a cell.
CustomizeDataRowEditor Allows you to customize a cell editor in a data row.
CustomizeEditModel Allows you to create a custom edit model or customize an automatically generated edit model.
CustomizeElement Allows you to customize grid elements.
CustomizeFilterMenu Allows you to customize column filter menu items.
CustomizeFilterRowEditor Allows you to customize a cell editor in the filter row.
CustomizeGroupValueDisplayText Allows you to customize the group value’s display text.
CustomizeSummaryDisplayText Allows you to customize the summary display text.
CustomSort Allows you to implement custom logic used to sort data in the grid.
CustomSummary Allows you to create custom summary items.
DataItemDeleting Fires when a user confirms the delete operation in the delete confirmation dialog.
EditCanceling Fires before the Grid cancels the edit operation and discards changes.
EditModelSaving Fires if validation succeeds after a user saves changes or you call the SaveChangesAsync() method.
EditStart Fires before the Grid starts editing a row.
FilterCriteriaChanged Fires when filter criteria applied to grid data change.
FocusedRowChanged Fires when the row focus changes.
LayoutAutoLoading Fires when the DxGrid component is initialized and starts to load its layout.
LayoutAutoSaving Fires when the grid’s layout changes.
PageIndexChanged Fires when the grid’s active page index changes.
PageSizeChanged Fires when the page size changes.
RowClick Fires when a user clicks or taps a grid row or focuses a data cell and presses Enter.
RowDoubleClick Fires when a user double clicks a grid row.
SearchTextChanged Fires when the search text changes.
SelectedDataItemChanged In single selection mode, fires when another Grid row is selected.
SelectedDataItemsChanged In multiple selection mode, fires when the selection in the Grid changes.
ShowAllRowsChanged Fires when the ShowAllRows property value changes.
UnboundColumnData Allows you to implement custom logic to obtain unbound column values.
See Also