GridControl Methods
The Data Grid control.| Name | Description |
|---|---|
| AddNewRow() | Adds a new record. |
| BeginDataUpdate() | Prevents visual and internal data updates until the DataControlBase.EndDataUpdate method is called. Inherited from DataControlBase. |
| BeginSelection() | Prevents selection updates until the DataControlBase.EndSelection method is called. Inherited from DataControlBase. |
| ClearColumnFilter(ColumnBase) | Removes the filter condition applied to the specified column. Inherited from DataControlBase. |
| ClearColumnFilter(String) | Removes the filter condition applied to the specified column. Inherited from DataControlBase. |
| ClearGrouping() | Ungroups the grid. |
| ClearGroupSummarySorting() | Clears sort by summary operations applied to the grid. |
| ClearSorting() | Clears the sorting applied to the grid. Inherited from DataControlBase. |
| CollapseAllGroups() | Collapses all group rows. |
| CollapseGroupRow(Int32, Boolean) | Collapses the specified group row and optionally any child group rows at all nesting levels. |
| CollapseGroupRow(Int32) | Collapses the specified group row. |
| CommitEditing() | Hides the active editor and posts all the changes made within the focused row to a data source if the row values are valid. Inherited from DataControlBase. |
| CopyToClipboard() | Copies selected rows/cells to the clipboard. |
| DeleteRow(Int32) | Deletes the specified data row. |
| EndDataUpdate() | Enables visual and internal data updates after the DataControlBase.BeginDataUpdate method call, and updates the grid. Inherited from DataControlBase. |
| EndSelection() | Enables selection updates after calling the DataControlBase.BeginSelection method, and forces an immediate update. Inherited from DataControlBase. |
| Equals(Object, Object) static | Determines whether the specified object instances are considered equal. Inherited from Object. |
| ExpandAllGroups() | Expands all group rows. |
| ExpandGroupRow(Int32, Boolean) | Expands the specified group row and optionally any child group rows at all nesting levels. |
| ExpandGroupRow(Int32) | Expands the specified group row. |
| FindRow(Object) | Searches for the data row in the GridControl and returns the row’s handle. |
| GetCellElementByRowHandleAndColumn(Int32, ColumnBase) | Returns the specified cell’s UI element. Inherited from DataControlBase. |
| GetCellValue(Int32, ColumnBase) | Returns the value of the specified data cell. |
| GetCellValue(Int32, String) | Returns the value of the specified data cell. |
| GetCellValueByListIndex(Int32, ColumnBase) | Returns the specified cell’s value. |
| GetCellValueByListIndex(Int32, String) | Returns the specified cell’s value. |
| GetChildRowCount(Int32) | Returns the number of child rows (group or data) contained within the specified group row. |
| GetChildRowHandle(Int32, Int32) | Returns the handle of the row contained within the specified group row, at the specified position. |
| GetColumnFilterCriteria(ColumnBase) | Returns a filter applied to the specified column. Inherited from DataControlBase. |
| GetColumnFilterCriteria(String) | Returns a filter applied to the specified column. Inherited from DataControlBase. |
| GetColumnFilterString(ColumnBase) | Returns a filter expression applied to the specified column. Inherited from DataControlBase. |
| GetColumnFilterString(String) | Returns a filter expression applied to the specified column. Inherited from DataControlBase. |
| GetDataRowHandleByGroupRowHandle(Int32) | Returns the handle of the first data row in the specified group row. |
| GetGroupRowValue(Int32, ColumnBase) | Returns the value of the group row that corresponds to the specified column. |
| GetGroupRowValue(Int32) | Returns the value of the specified group row. |
| GetGroupSummaryValue(Int32, SummaryItemBase) | Returns the value of the group summary displayed in the specified group row. |
| GetListIndexByRowHandle(Int32) | Returns the specified data row’s index in a data source. |
| GetParentRowHandle(Int32) | Determines a particular row’s parent group row. |
| GetRow(Int32) | Returns an object in a data source that corresponds to the specified row. |
| GetRowByListIndex(Int32) | Returns an object that represents the specified row. |
| GetRowElementByRowHandle(Int32) | Returns a UI element that is the specified row. Inherited from DataControlBase. |
| GetRowHandleByListIndex(Int32) | Returns the data row’s handle by its index in a data source. |
| GetRowHandleByVisibleIndex(Int32) | Returns a row’s handle by its visible index. |
| GetRowLevelByRowHandle(Int32) | Returns the specified row’s group level. |
| GetRowLevelByVisibleIndex(Int32) | Returns the specified row’s group level. |
| GetRowVisibleIndexByHandle(Int32) | Returns the row’s position in the GridControl by its handle. |
| GetSelectedCells() | Returns a list of selected data cells. |
| GetTotalSummaryValue(SummaryItemBase) | Returns the value of the specified total summary item. |
| GetType() | Gets the Type of the current instance. Inherited from Object. |
| GroupBy(ColumnBase, ColumnSortOrder, Int32) | Groups data by the values of the specified column and specifies its sort order and group index. |
| GroupBy(ColumnBase, ColumnSortOrder) | Groups data by the values of the specified column with the specified sort order. |
| GroupBy(ColumnBase, Int32) | Groups data by the values of the specified column with the specified group index. |
| GroupBy(ColumnBase) | Groups data by the values of the specified column. |
| GroupBy(String) | Groups data by the values of the specified column. |
| HideEditor() | Closes the active editor, discarding all the changes made. Inherited from DataControlBase. |
| IsCellSelected(Int32, ColumnBase) | Indicates whether the specified cell is selected. Inherited from DataControlBase. |
| IsGroupRowExpanded(Int32) | Indicates whether the specified group row is expanded. |
| IsGroupRowHandle(Int32) | Indicates whether the specified handle corresponds to a group row. |
| IsRowSelected(Int32) | Indicates whether the specified row is selected. Inherited from DataControlBase. |
| IsRowVisible(Int32) | Indicates whether the specified row is visible. |
| IsValidRowHandle(Int32) | Indicates whether the specified row handle is valid. |
| MemberwiseClone() protected | Creates a shallow copy of the current Object. Inherited from Object. |
| MergeColumnFilters(CriteriaOperator) |
Combines the specified filter with the grid’s current filter with the AND operator.
Inherited from DataControlBase. |
| MergeColumnFilters(String) |
Combines the specified filter with the grid’s current filter with the AND operator.
Inherited from DataControlBase. |
| MoveColumnTo(ColumnBase, Int32) | Moves the specified column to the specified position. Inherited from DataControlBase. |
| MoveFirstRow() | Moves focus to the first visible row within a grid. Inherited from DataControlBase. |
| MoveLastRow() | Moves focus to the last visible row within a grid. Inherited from DataControlBase. |
| MoveNextPage() | Moves focus forward to the bottom row displayed onscreen within a grid. Inherited from DataControlBase. |
| MoveNextRow() | Moves focus to the row following the one currently focused. |
| MovePrevPage() | Moves focus backward to the top row displayed onscreen within a grid. Inherited from DataControlBase. |
| MovePrevRow(Boolean) | Moves focus to the row that precedes the focused row, and specifies whether this method can focus the Automatic Filter Row. |
| PasteFromClipboard() | Pastes clipboard data to the GridControl. |
| PostEditor() | Saves the active editor’s value to a data source without closing the editor. Inherited from DataControlBase. |
| ReferenceEquals(Object, Object) static | Determines whether the specified Object instances are the same instance. Inherited from Object. |
| RefreshData() | Updates the control data. Inherited from DataControlBase. |
| RefreshRow(Int32) | Reloads the specified row from a data source. |
| ScrollIntoView(ColumnBase) | Makes the specified column visible onscreen. Inherited from DataControlBase. |
| ScrollIntoView(Int32) | Makes the specified row visible onscreen. Inherited from DataControlBase. |
| ScrollIntoView(Object) | Makes the specified row visible onscreen. Inherited from DataControlBase. |
| SelectAll() | Selects all items within a grid. Inherited from DataControlBase. |
| SelectCell(Int32, ColumnBase) | Selects the specified cell. Inherited from DataControlBase. |
| SelectCells(Int32, ColumnBase, Int32, ColumnBase) | Selects multiple cells. Inherited from DataControlBase. |
| SelectItem(Int32) | Selects the specified row. Inherited from DataControlBase. |
| SelectItem(Object) | Selects the specified item. Inherited from DataControlBase. |
| SelectRange(Int32, Int32) | Selects multiple items, while preserving the current selection (if any). Inherited from DataControlBase. |
| SetCellValue(Int32, ColumnBase, Object) | Sets the specified cell’s value. |
| SetCellValue(Int32, String, Object) | Sets the specified cell’s value. |
| ShowEditor() | Activates the focused cell’s inplace editor. Inherited from DataControlBase. |
| SortBy(ColumnBase, ColumnSortOrder, Int32) | Sorts data by the values of the specified column in the specified order, and places the column at the specified position among the sorted columns. Inherited from DataControlBase. |
| SortBy(ColumnBase, ColumnSortOrder) | Sorts data by the values of the specified column in the specified order. Inherited from DataControlBase. |
| SortBy(ColumnBase) | Sorts data by the values of the specified column. Inherited from DataControlBase. |
| SortBy(String, ColumnSortOrder) | Sorts data by the values of the specified column in the specified order. Inherited from DataControlBase. |
| SortBy(String) | Sorts data by the values of the specified column. Inherited from DataControlBase. |
| ToString() | Returns a string that represents the current object. Inherited from Object. |
| UngroupBy(ColumnBase) | Ungroups data by the values of the specified column. |
| UngroupBy(String) | Ungroups data by the values of the specified column. |
| UnselectAll() | Unselects any selected items within a grid. Inherited from DataControlBase. |
| UnselectCell(Int32, ColumnBase) | Unselects the specified cell. Inherited from DataControlBase. |
| UnselectCells(Int32, ColumnBase, Int32, ColumnBase) | Unselects multiple cells. Inherited from DataControlBase. |
| UnselectItem(Int32) | Unselects the specified row. Inherited from DataControlBase. |
| UnselectItem(Object) | Unselects the specified item. Inherited from DataControlBase. |
| UpdateGroupSummary() | Recalculates group summaries. |
| UpdateTotalSummary() | Updates total summaries. Inherited from DataControlBase. |
See Also