DxDataGrid<T> Members

A Data Grid component.

Constructors

Name Description
DxDataGrid() Initializes a new instance of the DxDataGrid<T> class with the default settings.

Properties

Name Description
AllowColumnDragDrop Specifies whether users can drag and drop a data grid's columns.
AllowSort Specifies whether users can sort grid data.
AutoCollapseDetailRow Specifies whether an expanded detail row should be automatically collapsed when an end user expands another detail row.
ColumnResizeMode Specifies whether and how users can resize Data Grid columns.
Columns Specifies the data grid's column collection.
CssClass Specifies the name of the component's CSS class. Inherited from DxComponentBase.
CustomData Specifies an asynchronous function that loads grid data based on the specified load options.
Data Specifies a strongly typed collection that supplies grid data.
DataAsync Specifies an asynchronous function that returns grid data.
DataNavigationMode Specifies how users navigate through grid data.
DataRowCssClass Specifies the CSS class for grid rows.
DetailRows Provides access to a detail row's settings.
DetailRowTemplate Specifies a template used to display a detail row.
EditFormTemplate Specifies a template used to display the edit form.
EditMode Specifies how users edit grid data.
GroupSummary Specifies the collection of group summary items.
HeaderTemplate Specifies a template for a Data Grid's header.
HorizontalScrollBarMode Specifies the horizontal scroll bar's display mode.
Id For internal use only. Inherited from DxComponentBase.
InnerComponentSizeMode Specifies the size of the Data Grid's inner components.
KeyFieldName Specifies the key data field's name.
MultipleSelectedDataRows Specifies the selected data rows.
PageCount Gets the total number of pages in the grid.
PageIndex Specifies the grid active page's index.
PagerAllDataRowsItemVisible Specifies whether the All item is displayed in the page size selector.
PagerAllowedPageSizes Specifies predefined page sizes displayed in the page size selector.
PagerAutoHideNavButtons Specifies whether or not Data Grid pager's navigation buttons are hidden when all numeric buttons are displayed.
PagerNavigationMode Specifies how users navigate between the grid pages.
PagerPageSizeSelectorVisible Specifies whether the page size selector is displayed.
PagerSwitchToInputBoxButtonCount Specifies the number of pages when the Data Grid's pager switches from numeric buttons to the Go to Page input box in Auto mode.
PagerVisibleNumericButtonCount Specifies the maximum number of numeric buttons the Data Grid's pager displays simultaneously in NumericButtons mode.
PageSize Specifies the maximum number of rows that the grid can display on a page.
PopupEditFormHeaderText Specifies text displayed in the pop-up Edit Form's header.
RowPreviewTemplate Specifies a template used to display row preview sections.
SelectAllMode Specifies whether the grid selects all rows on a page or all pages.
SelectionMode Specifies whether users can select rows in the grid.
ShowColumnHeaders Specifies whether the grid displays column headers.
ShowDetailRow Specifies whether to display detail rows.
ShowFilterRow Specifies whether the grid displays the filter row.
ShowGroupedColumns Specifies whether grouped columns are displayed within the data grid.
ShowGroupPanel Specifies whether the Group Panel is visible in the grid.
ShowPager Specifies whether the grid displays the pager.
SingleSelectedDataRow Specifies the selected data row.
TotalSummary Specifies the collection of total summary items.
VerticalScrollableHeight Specifies the scrollable area's height.
VerticalScrollBarMode Specifies the vertical scrollbar’s display mode.

Methods

Name Description
CancelRowEdit() Asynchronously closes the edit form and does not save changes.
ClearSelection() Deselects all records in the grid.
Equals(Object) Determines whether the specified object is equal to the current object. Inherited from Object.
Equals(Object, Object) static Determines whether the specified object instances are considered equal. Inherited from Object.
GetHashCode() Serves as the default hash function. Inherited from Object.
GetType() Gets the Type of the current instance. Inherited from Object.
IsDataRowSelected(T) Returns a value that specifies whether or not a data row is selected.
LoadLayout(String) Restores a grid's layout.
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.
Refresh() Reloads data and redraws the Data Grid component.
SaveLayout() Saves information about a grid's layout.
SelectAll() Selects all rows in the grid.
SetDataRowSelected(T, Boolean) Specifies a data row's selection state.
SetDataRowSelectedByKey(Object, Boolean) Specifies selection state of a data row with the specified key.
StartRowEdit(Object) Asynchronously displays the edit form for the specified data row or a new row.
ToString() Returns a string that represents the current object. Inherited from Object.

Events

Name Description
HtmlDataCellDecoration Allows you to change an individual cell's decoration settings.
HtmlRowDecoration Allows you to change an individual row's decoration settings.
InitNewRow Enables you to initialize added data rows.
LayoutChanged Fires when a user changes a grid's layout.
LayoutRestoring Fires when a grid has been initialized and you can restore its layout (if needed).
MultipleSelectedDataRowsChanged Occurs when a user changed selection in multiple selection mode.
OptimizedMultipleSelectionChanged Occurs when a user changed selection in optimized multiple selection mode.
PageCountChanged Fires when the total number of grid pages changes.
PageIndexChanged Fires when the grid's active page is changed.
RowClick Fires when a user clicks a grid's data row.
RowEditCancel Occurs when the edit form closes and discards changes.
RowEditCancelAsync Occurs when the edit form closes and discards changes. Allows you to await handler execution without blocking the Data Grid.
RowEditStart Occurs when the edit form is opened to edit a data row.
RowEditStartAsync Occurs when the edit form is opened to edit a data row and allows you to await handler execution without blocking the Data Grid.
RowInserting Occurs when a user adds a new data row.
RowInsertingAsync Occurs when a user adds a new data row and allows you to await handler execution without blocking the Data Grid.
RowInsertStart Occurs when the edit form is opened to add a data row.
RowInsertStartAsync Occurs when the edit form is opened to add a data row and allows you to await handler execution without blocking the Data Grid.
RowRemoving Occurs when a user removes a data row.
RowRemovingAsync Occurs when a user removes a data row and allows you to await handler execution without blocking the Data Grid.
RowUpdating Occurs when a user updates a data row.
RowUpdatingAsync Occurs when a user updates a data row and allows you to await handler execution without blocking the Data Grid.
SingleSelectedDataRowChanged Occurs when a user changed selection in single selection mode.
See Also