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

IGrid Methods

A base interface for the DxGrid.
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.
ExpandAllGroupRows() Expands all group rows.
ExpandGroupRow(Int32, Boolean) Expands the group row.
FilterBy(String, GridFilterRowOperatorType, Object) Filters 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.
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() Get 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.
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 the values of the specified data source field and places the grouped column to the specified position among other grouped columns.
GroupBy(String) Groups data by the values of the specified data source field.
IsGroupRow(Int32) Specifies whether the specified row is a group row.
IsGroupRowExpanded(Int32) Specifies whether the specified row is a group row.
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.
WaitForDataLoadAsync() Returns a task that completes when pending asynchronous data load operations are completed.
See Also