Skip to main content
A newer version of this page is available. .

DxGrid Members

A Grid component.

Constructors

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

Properties

Name Description
AllowGroup Specifies whether users can group grid data.
AllowSort Specifies whether users can sort grid data.
AutoExpandAllGroupRows Specifies whether to expand all group rows automatically when the grid loads data or users interact with the grid.
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.
Columns Allows you to add Grid columns.
CssClass Specifies the name of a CSS class applied to the Grid.
Data Specifies an object that supplies Grid data.
DataColumnCellDisplayTemplate Specifies a common template used to display all data column cells in the Grid.
DataColumnGroupRowTemplate Specifies a common template used to display all group rows in the Grid.
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.
PageIndex Specifies the grid’s active page index.
PageSize Specifies the maximum number of rows that the grid can display on a 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.
TotalSummary Contains total summary items.

Methods

Name Description
BeginUpdate() Suspends Grid updates caused by parameter changes and method calls until the EndUpdate() method is called.
ClearFilter() Clears the filter applied to grid data.
ClearSort() Clears sorting.
CollapseAllGroupRows() Collapses all group rows.
CollapseGroupRow(Int32, Boolean) Collapses the group row.
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.
ExpandGroupRow(Int32, Boolean) Expands the group row.
FilterBy(String, GridFilterRowOperatorType, Object) Filters grid data by the specified value of the data source field.
GetColumns() Returns a column collection.
GetDataColumns()
GetDataItem(Int32) Gets a data source item that is bound to the processed 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.
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 column collection ordered based on visible indexes.
GetVisibleRowCount() Gets the total number of visible rows in the grid.
GroupBy(String, Int32) Groups data by values of the specified data source field and adds the grouped column to the specified position among other grouped columns.
GroupBy(String) Groups data by values of the specified data source field.
IsGroupRow(Int32) Specifies whether the specified row is a group row.
IsGroupRowExpanded(Int32) Specifies whether the specified group row is expanded.
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.
Reload()
SortBy(String, GridColumnSortOrder, Int32) Sorts data by the values of the data source field in the specified order, and specifies the sorted column’s index.
SortBy(String, GridColumnSortOrder) Sorts data by the values of the data source field in the specified order.
SortBy(String) Sorts data by the values of the specified data source field.
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.

Events

Name Description
CustomGroup Enables you to implement custom logic used to group data in the grid.
CustomizeCellDisplayText Allows you to customize the text displayed within a cell.
CustomizeGroupValueDisplayText Allows you to customize the text displayed within a group.
CustomizeSummaryDisplayText Allows you to customize the summary display text.
CustomSort Allows you to implement custom logic used to sort data in the grid.
CustomSummary Specifies data for custom summary items.
PageIndexChanged Fires when the grid’s active page index changes.
PageSizeChanged
UnboundColumnData Specifies data for unbound columns.
See Also