GridControl Methods

Show Inherited Hide Inherited

The 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.
BeginInit()	Starts the control’s runtime initialization. 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.
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.
DeleteRow(Int32)	Deletes the specified data row. Inherited from GridControlBase.
EndDataUpdate()	Enables visual and internal data updates after the DataControlBase.BeginDataUpdate method call, and updates the grid. Inherited from DataControlBase.
EndInit()	Ends the runtime initialization. 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.
Equals(Object)	Determines whether the specified object is equal to the current object. 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.
GetCellElementByRowHandleAndColumn(Int32, ColumnBase)	Returns the specified cell’s UI element. Inherited from DataControlBase.
GetCellElementByTreeElement(DependencyObject)	Returns a cell that contains the specified tree element. Inherited from DataControlBase.
GetCellValue(Int32, GridColumnBase)	Returns the value of the specified data cell.
GetCellValue(Int32, String)	Returns the value of the specified data cell. Inherited from DataControlBase.
GetCellValueByListIndex(Int32, GridColumnBase)	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.
GetColumnByTreeElement(DependencyObject)	Returns a column whose cell contains the specified tree element. Inherited from DataControlBase.
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.
GetCurrentGrid(DependencyObject) static	Gets the value of the DataControlBase.CurrentGrid attached property for a specified DependencyObject. Inherited from DataControlBase.
GetCurrentViewChangedListener(DependencyObject) static	Gets the value of the DataControlBase.CurrentViewChangedListener attached property for a specified DependencyObject. Inherited from DataControlBase.
GetGroupRowValue(Int32, GridColumnBase)	Returns a value of the specified group row in the specified grouping column.
GetGroupRowValue(Int32)	Returns the value of the specified group row.
GetHashCode()	Serves as the default hash function. Inherited from Object.
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 specifying its visible index.
GetRowState(Int32)	This member supports the internal infrastructure and is not intended to be used directly from your code. Inherited from DataControlBase.
GetRowVisibleIndexByHandle(Int32)	Returns the row’s position within a grid by its handle.
GetSelectedCells()	Returns the selected data cells. Inherited from DataControlBase.
GetSelectedItem()	Returns the currently selected row.
GetSelectedItemCellValue(GridColumnBase)	Returns the value of the specified cell contained within the focused row.
GetSelectedItemCellValue(String)	Returns the value of the specified cell contained within the selected row.
GetTotalSummaryValue(SummaryItemBase)	Returns the value of the specified total summary item. Inherited from DataControlBase.
GetType()	Gets the Type of the current instance. Inherited from Object.
GroupBy(GridColumnBase, ColumnSortOrder, Int32)	Groups data by the values of the specified column with the specified sort order. If several columns are involved in grouping, the specified column will reside at the specified grouping level.
GroupBy(GridColumnBase, ColumnSortOrder)	Groups data by the values of the specified column with the specified sort order.
GroupBy(GridColumnBase, Int32)	Groups data by the values of the specified column. If several columns are involved in grouping, the specified column will reside at the specified grouping level.
GroupBy(GridColumnBase)	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.
IsGroupRow(Int32, Int32)	Indicates whether the specified index corresponds to a group row. For internal use only. Inherited from GridControlBase.
IsGroupRowExpanded(Int32)	Indicates whether the specified group row is expanded.
IsItemSelected(Int32)	Indicates whether the specified item 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.
MoveNextRow()	Moves focus to the row following the one currently focused.
MovePrevPage()
MovePrevRow(Boolean)
MoveSelectedItem(Int32)	Selects the specified item. Inherited from DataControlBase.
PopulateColumns()	Creates columns for all fields in a bound data source. Inherited from DataControlBase.
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.
ScrollIntoView(Int32)	Makes the specified row visible onscreen.
ScrollIntoView(Object)	Makes the specified row visible onscreen. Inherited from DataControlBase.
SelectAll()	Selects all items within a grid. Inherited from DataControlBase.
SelectCell(Int32, GridColumnBase)	Selects the cell. Inherited from DataControlBase.
SelectCells(Int32, GridColumnBase, Int32, GridColumnBase)	Selects multiple cells. Inherited from DataControlBase.
SelectItem(Int32)	Selects the specified item. 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.
SetCurrentGrid(DependencyObject, DataControlBase) static	Sets the value of the DataControlBase.CurrentGrid attached property to a specified DependencyObject. Inherited from DataControlBase.
SetCurrentViewChangedListener(DependencyObject, INotifyCurrentViewChanged) static	Sets the value of the DataControlBase.CurrentViewChangedListener attached property to a specified DependencyObject. Inherited from DataControlBase.
SetSelectedItemUnboundColumnValue(GridColumnBase, Object)	Sets the value of the specified unbound column cell contained within the selected row.
SetSelectedItemUnboundColumnValue(String, Object)	Sets the value of the specified unbound column value in the selected item.
SetUnboundColumnValue(Int32, GridColumnBase, Object)	Sets the value of the specified unbound column cell.
SetUnboundColumnValue(Int32, String, Object)	Sets the specified unbound column cell value.
ShowEditor()	Activates the focused cell’s inplace editor. Inherited from DataControlBase.
SortBy(GridColumnBase, 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.
SortBy(GridColumnBase, ColumnSortOrder)	Sorts data by the values of the specified column in the specified order.
SortBy(GridColumnBase)	Sorts data by the values of the specified column.
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(GridColumnBase)	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, GridColumnBase)	Unselects the specified cell. Inherited from DataControlBase.
UnselectCells(Int32, GridColumnBase, Int32, GridColumnBase)	Unselects the specified cells. Inherited from DataControlBase.
UnselectItem(Int32)	Unselects the specified item. Inherited from DataControlBase.
UnselectItem(Object)	Unselects the specified item. Inherited from DataControlBase.
UpdateTotalSummary()	Updates total summaries. Inherited from DataControlBase.
UpdateUnboundColumnValues(Int32)	Updates unbound column values in the specified row. Inherited from DataControlBase.