IGrid Methods

An interface that defines the DxGrid component’s API members (properties and methods).

Name	Description
BeginUpdate()	Suspends Grid updates caused by parameter changes and method calls until the EndUpdate() method is called.
CancelEditAsync()	Closes the edit form or edit row 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 the group row.
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.
ExpandAllGroupRows()	Expands all group rows.
ExpandDetailRow(Int32)	Expands the specified detail row.
ExpandGroupRow(Int32, Boolean)	Expands the group row.
FilterBy(String, GridFilterRowOperatorType, Object)	Filters data by the specified column value.
GetColumns()	Returns a column collection.
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 field value of the specified data item.
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.
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()	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 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.
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 currently being edited.
IsEditingNewRow()	Returns whether a new Grid row is currently being edited.
IsEditingRow(Int32)	Returns whether the specified Grid row is currently being edited.
IsGroupRow(Int32)	Specifies whether the specified row is a group row.
IsGroupRowExpanded(Int32)	Specifies whether the specified row is a group row.
IsRowSelected(Int32)	Returns whether the specified row is selected.
LoadLayout(GridPersistentLayout)	Restores the DxGrid‘s layout.
RefreshSummary()	Refreshes all total and group summary values in the grid.
Reload()	Reloads Grid data.
SaveChangesAsync()	Saves changes made in the edit form or edit row.
SaveLayout()	Saves information about the DxGrid‘s layout.
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.
ShowColumnChooser(String)	Shows the Column Chooser.
ShowDataItemDeleteConfirmation(Object)	Displays the delete confirmation dialog for the specified data item.
ShowRowDeleteConfirmation(Int32)	Displays the delete confirmation dialog for the specified row.
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)	Displays the edit form or edit row used to modify the specified data item.
StartEditNewRowAsync()	Displays the edit form or edit row used to create a new data row.
StartEditRowAsync(Int32)	Displays the edit form or edit row used to modify the specified row.
WaitForDataLoadAsync()	Returns a task that completes when pending asynchronous data load operations are completed.
WaitForInstantFeedbackRowLoadAsync(Int32)	Returns a task that is completed when the specified row of an asynchronous Instant Feedback Data Source is loaded.