Skip to main content
BuyLog In
WinUI Controls
Search in…
Docs > API Reference > DevExpress.WinUI.Grid > GridControl > Members
All docs
V23.2
WinUI Controls
API Reference
DevExpress.Mvvm
DevExpress.WinUI.Charts
DevExpress.WinUI.Controls
DevExpress.WinUI.Core
DevExpress.WinUI.DocumentViewer
DevExpress.WinUI.Drawing
DevExpress.WinUI.Editors
DevExpress.WinUI.Gauges
DevExpress.WinUI.Grid
AlternateRowBackgroundPalette
AlternateRowBackgroundPaletteItem
AutoFilterCondition
AutoFilterRowData
AutoGeneratingColumnEventArgs
AutoGeneratingColumnEventHandler
BaseAsyncArgs
CellData
CellStyleSettings
CellValueChangedEventArgs
CellValueChangedEventHandler
CellValueEventHandler
ClipboardCopyFormats
ClipboardInfoType
ClipboardRowCopyingEventArgs
ClipboardRowCopyingEventHandler
ClipboardRowPastingEventArgs
ClipboardRowPastingEventHandler
ClipboardValueInfo
ClipboardValueInfoCollection
ColumnBase
ColumnFilterMode
ConditionRule
CriteriaOperatorType
CurrentColumnChangedEventArgs
CurrentColumnChangedEventHandler
CurrentItemChangedEventArgs
CurrentItemChangedEventHandler
CustomCellAppearanceEventArgs
CustomColumnDisplayTextEventArgs
CustomColumnDisplayTextEventHandler
CustomColumnSortEventArgs
CustomColumnSortEventHandler
CustomGroupDisplayTextEventArgs
CustomGroupDisplayTextEventHandler
CustomUniqueValuesEventArgs
CustomUniqueValuesEventHandler
DataControlBase
DataControlCommandsBase
EditorEventArgs
EditorEventArgsBase
EditorEventHandler
ExceptionMode
FetchEventArgsBase
FetchMode
FetchRowsAsyncEventArgs
FetchRowsEventArgsBase
FetchRowsResult
FilterPopupEventArgs
FilterPopupEventHandler
FilterPopupMode
FindMode
Format
FormatCondition
FormatConditionBase
FormatConditionCollection
GetSummariesAsyncEventArgs
GetSummariesEventArgsBase
GetUniqueValuesAsyncEventArgs
GetUniqueValuesEventArgsBase
GridCell
GridCellValidationEventArgs
GridCheckBoxColumn
GridColumnCollection
GridColumnCommands
GridColumnContextMenuInfo
GridColumnDataEventArgs
GridColumnDataEventHandler
GridColumnUnitType
GridColumnWidth
GridComboBoxColumn
GridCommonContextMenuInfo
GridContextMenuInfoBase
GridContextMenuType
GridControl
Members
Constructors
Fields
Properties
Methods
Events
GridControlCommands
GridDateColumn
GridGroupPanelContextMenuInfo
GridGroupSummaryItem
GridGroupSummaryItemCollection
GridMaskColumn
GridPrintBrickStyle
GridRowCellContextMenuInfo
GridRowValidationEventArgs
GridSelectionChangedEventArgs
GridSelectionChangedEventHandler
GridSpinEditColumn
GridTemplateColumn
GridTextColumn
GridTextColumnBase
GridTotalSummaryData
GridTotalSummaryItem
GridTotalSummaryItemCollection
GroupColumnSummaryData
GroupRowData
GroupRowExpandButton
GroupRowExpandButtonStyleSettings
GroupSummaryData
GroupSummaryDisplayMode
GroupValueData
HeaderData
HeaderRowData
IndicatorState
InfiniteAsyncSource
InfiniteSourceBase
InitNewRowEventArgs
InitNewRowEventHandler
InvalidRowExceptionEventArgs
InvalidRowExceptionEventHandler
ItemsSourceChangedEventArgs
ItemsSourceChangedEventHandler
MultiSelectMode
NavigationStyle
NewItemRowData
NewItemRowPosition
PasteOperationException
PredefinedFormatNames
RowAllowEventArgs
RowAllowEventHandler
RowData
RowDataBase
RowEventArgs
RowEventHandler
RowFilterEventArgs
RowFilterEventHandler
RowIndicatorImage
RowIndicatorStyleSettings
RowSelectionState
RowsFetchState
RowStyleSettings
SearchPanel
SearchPanelHighlightSettings
ShowFilterPanelMode
ShowSearchPanelMode
SummaryItemAlignment
SummaryItemBase
SummaryType
ToolTipShowMode
TopBottomRule
TopBottomRuleFormatCondition
TotalSummaryControl
TotalSummaryRowData
UniqueDuplicateRule
UniqueDuplicateRuleFormatCondition
VirtualSourceBase
DevExpress.WinUI.Grid.Printing
DevExpress.WinUI.Localization
DevExpress.WinUI.Printing
DevExpress.WinUI.Ribbon
DevExpress.WinUI.Scheduler
Download CHM

GridControl Members

The Data Grid control.

Constructors

Name Description
GridControl() Initializes a new instance of the GridControl class with default settings.

Fields

Name Description
ActiveEditorProperty static Identifies the DataControlBase.ActiveEditor dependency property. Inherited from DataControlBase.
ActualGroupCountProperty static Identifies the GridControl.ActualGroupCount dependency property.
ActualShowFilterPanelProperty static Identifies the DataControlBase.ActualShowFilterPanel dependency property. Inherited from DataControlBase.
AllowCommitOnValidationAttributeErrorProperty static Identifies the DataControlBase.AllowCommitOnValidationAttributeError dependency property. Inherited from DataControlBase.
AllowCopyToClipboardProperty static Identifies the AllowCopyToClipboard dependency property. Inherited from DataControlBase.
AllowLeaveInvalidEditorProperty static Identifies the DataControlBase.AllowLeaveInvalidEditor dependency property. Inherited from DataControlBase.
AllowLiveDataShapingProperty static Identifies the AllowLiveDataShaping dependency property. Inherited from DataControlBase.
AlternateRowBackgroundPaletteProperty static Identifies the AlternateRowBackgroundPalette dependency property. Inherited from DataControlBase.
AlternateRowBackgroundProperty static Identifies the AlternateRowBackground dependency property. Inherited from DataControlBase.
AlternationCountProperty static Identifies the AlternationCount dependency property. Inherited from DataControlBase.
AutoExpandAllGroupsProperty static Identifies the GridControl.AutoExpandAllGroups dependency property.
AutoFilterRowHandle static Gets the handle of the Automatic Filter Row. Inherited from DataControlBase.
AutoGenerateColumnsProperty static Identifies the DataControlBase.AutoGenerateColumns dependency property. Inherited from DataControlBase.
AutoScrollOnSortingProperty static Identifies the DataControlBase.AutoScrollOnSorting dependency property. Inherited from DataControlBase.
AutoWidthProperty static Identifies the AutoWidth dependency property. Inherited from DataControlBase.
CellToolTipShowModeProperty static Identifies the CellToolTipShowMode dependency property. Inherited from DataControlBase.
ClipboardCopyFormatsProperty static Identifies the ClipboardCopyFormats dependency property. Inherited from DataControlBase.
ColumnMenuProperty static Identifies the GridControl.ColumnMenu dependency property.
ColumnsSourceProperty static Identifies the ColumnsSource dependency property. Inherited from DataControlBase.
ColumnTemplateProperty static Identifies the ColumnTemplate dependency property. Inherited from DataControlBase.
ColumnTemplateSelectorProperty static Identifies the ColumnTemplateSelector dependency property. Inherited from DataControlBase.
CommandsProperty static Identifies the DataControlBase.Commands dependency property. Inherited from DataControlBase.
CopyColumnHeadersToClipboardProperty static Identifies the CopyColumnHeadersToClipboard dependency property. Inherited from DataControlBase.
CurrentColumnProperty static Identifies the CurrentColumn dependency property. Inherited from DataControlBase.
CurrentItemProperty static Identifies the DataControlBase.CurrentItem dependency property. Inherited from DataControlBase.
FilterCriteriaProperty static Identifies the DataControlBase.FilterCriteria dependency property. Inherited from DataControlBase.
FilterPanelTextProperty static Identifies the DataControlBase.FilterPanelText dependency property. Inherited from DataControlBase.
FilterStringProperty static Identifies the DataControlBase.FilterString dependency property. Inherited from DataControlBase.
FixedTotalSummaryItemTemplateProperty static Identifies the DataControlBase.FixedTotalSummaryItemTemplate dependency property. Inherited from DataControlBase.
GridMenuProperty static Identifies the GridControl.GridMenu dependency property.
GroupLevelIndentProperty static Identifies the GroupLevelIndent dependency property.
GroupPanelMenuProperty static Identifies the GridControl.GroupPanelMenu dependency property.
GroupRowExpandButtonStyleSettingsProperty static Identifies the GroupRowExpandButtonStyleSettings dependency property.
GroupRowExpandButtonTemplateProperty static Identifies the GroupRowExpandButtonTemplate dependency property.
GroupRowMinHeightProperty static Identifies the GroupRowMinHeight dependency property.
GroupRowStyleSettingsProperty static Identifies the GroupRowStyleSettings dependency property.
GroupSummaryDisplayModeProperty static Identifies the GridControl.GroupSummaryDisplayMode dependency property.
GroupSummaryItemTemplateProperty static Identifies the GroupSummaryItemTemplate dependency property.
GroupValueTemplateProperty static Identifies the GroupValueTemplate dependency property.
HasValidationErrorProperty static Identifies the DataControlBase.HasValidationError dependency property. Inherited from DataControlBase.
HeaderToolTipShowModeProperty static Identifies the HeaderToolTipShowMode dependency property. Inherited from DataControlBase.
HighlightRowOnHoverProperty static Identifies the HighlightRowOnHover dependency property. Inherited from DataControlBase.
HorizontalScrollBarVisibilityProperty static Identifies the HorizontalScrollBarVisibility dependency property. Inherited from DataControlBase.
ImplyNullLikeEmptyStringWhenFilteringProperty static Identifies the ImplyNullLikeEmptyStringWhenFiltering dependency property. Inherited from DataControlBase.
IncrementalLoadingThresholdProperty static Identifies the DataControlBase.IncrementalLoadingThreshold dependency property. Inherited from DataControlBase.
InvalidRowHandle static Gets the handle of a row which does not exist in a grid. Inherited from DataControlBase.
InvalidRowIndex static Gets the index of a row which does not exist in the GridControl. Inherited from DataControlBase.
IsFilterEnabledProperty static Identifies the DataControlBase.IsFilterEnabled dependency property. Inherited from DataControlBase.
IsGroupedProperty static Identifies the GridControl.IsGrouped dependency property.
IsGroupPanelVisibleProperty static Identifies the IsGroupPanelVisible dependency property.
IsSearchPanelVisibleProperty static Identifies the IsSearchPanelVisible dependency property. Inherited from DataControlBase.
IsSynchronizedWithCurrentItemProperty static Identifies the DataControlBase.IsSynchronizedWithCurrentItem dependency property. Inherited from DataControlBase.
ItemsSourceProperty static Identifies the DataControlBase.ItemsSource dependency property. Inherited from DataControlBase.
KeepFocusedRowOnUpdateProperty static Identifies the KeepFocusedRowOnUpdate dependency property.
LineBrushProperty static Identifies the LineBrush dependency property. Inherited from DataControlBase.
NavigationStyleProperty static Identifies the DataControlBase.NavigationStyle dependency property. Inherited from DataControlBase.
NewItemRowHandle static Gets the handle of the New Item Row. Inherited from DataControlBase.
NewItemRowPositionProperty static Identifies the NewItemRowPosition dependency property. Inherited from DataControlBase.
PasteModeProperty static Identifies the PasteMode dependency property. Inherited from DataControlBase.
PredefinedFormatsProperty static Identifies the PredefinedFormats dependency property. Inherited from DataControlBase.
PreserveSortingProperty static Identifies the DataControlBase.PreserveSorting dependency property. Inherited from DataControlBase.
PrintAllGroupsExpandedProperty static Identifies the PrintAllGroupsExpanded dependency property.
PrintAutoWidthProperty static Identifies the PrintAutoWidth dependency property.
PrintColumnHeadersProperty static Identifies the PrintColumnHeaders dependency property.
PrintColumnHeaderStyleProperty static Identifies the PrintColumnHeaderStyle dependency property.
PrintFixedTotalSummaryProperty static Identifies the PrintFixedTotalSummary dependency property.
PrintFixedTotalSummaryStyleProperty static Identifies the PrintFixedTotalSummaryStyle dependency property.
PrintGroupLevelIndentProperty static Identifies the PrintGroupLevelIndent dependency property.
PrintGroupRowStyleProperty static Identifies the PrintGroupRowStyle dependency property.
PrintGroupSummaryProperty static Identifies the PrintGroupSummary dependency property.
PrintTotalSummaryProperty static Identifies the PrintTotalSummary dependency property.
PrintTotalSummaryStyleProperty static Identifies the PrintTotalSummaryStyle dependency property.
RowCellMenuProperty static Identifies the GridControl.RowCellMenu dependency property.
RowIndicatorHeaderTemplateProperty static Identifies the RowIndicatorHeaderTemplate dependency property. Inherited from DataControlBase.
RowIndicatorStyleSettingsProperty static Identifies the RowIndicatorStyleSettings dependency property. Inherited from DataControlBase.
RowIndicatorTemplateProperty static Identifies the RowIndicatorTemplate dependency property. Inherited from DataControlBase.
RowIndicatorWidthProperty static Identifies the RowIndicatorWidth dependency property. Inherited from DataControlBase.
RowMinHeightProperty static Identifies the RowMinHeight dependency property. Inherited from DataControlBase.
RowStyleSettingsProperty static Identifies the RowStyleSettings dependency property. Inherited from DataControlBase.
SearchColumnsProperty static Identifies the DataControlBase.SearchColumns dependency property. Inherited from DataControlBase.
SearchDelayProperty static Identifies the DataControlBase.SearchDelay dependency property. Inherited from DataControlBase.
SearchPanelAllowFilterProperty static Identifies the DataControlBase.SearchPanelAllowFilter dependency property. Inherited from DataControlBase.
SearchPanelClearOnCloseProperty static Identifies the DataControlBase.SearchPanelClearOnClose dependency property. Inherited from DataControlBase.
SearchPanelCriteriaOperatorTypeProperty static Identifies the DataControlBase.SearchPanelCriteriaOperatorType dependency property. Inherited from DataControlBase.
SearchPanelFindFilterProperty static Identifies the DataControlBase.SearchPanelFindFilter dependency property. Inherited from DataControlBase.
SearchPanelFindModeProperty static Identifies the DataControlBase.SearchPanelFindMode dependency property. Inherited from DataControlBase.
SearchPanelHighlightResultsProperty static Identifies the DataControlBase.SearchPanelHighlightResults dependency property. Inherited from DataControlBase.
SearchPanelHighlightSettingsProperty static Identifies the SearchPanelHighlightSettings dependency property. Inherited from DataControlBase.
SearchStringProperty static Identifies the DataControlBase.SearchString dependency property. Inherited from DataControlBase.
SelectedItemProperty static Identifies the DataControlBase.SelectedItem dependency property. Inherited from DataControlBase.
SelectedItemsProperty static Identifies the DataControlBase.SelectedItems dependency property. Inherited from DataControlBase.
SelectionModeProperty static Identifies the DataControlBase.SelectionMode dependency property. Inherited from DataControlBase.
ShowAutoFilterRowProperty static Identifies the ShowAutoFilterRow dependency property. Inherited from DataControlBase.
ShowColumnHeadersProperty static Identifies the DataControlBase.ShowColumnHeaders dependency property. Inherited from DataControlBase.
ShowFilterPanelModeProperty static Identifies the DataControlBase.ShowFilterPanelMode dependency property. Inherited from DataControlBase.
ShowFixedTotalSummaryProperty static Identifies the DataControlBase.ShowFixedTotalSummary dependency property. Inherited from DataControlBase.
ShowGroupedColumnsProperty static Identifies the ShowGroupedColumns dependency property.
ShowGroupPanelProperty static Identifies the ShowGroupPanel dependency property.
ShowGroupRowExpandButtonProperty static Identifies the ShowGroupRowExpandButton dependency property.
ShowHorizontalLinesProperty static Identifies the ShowHorizontalLines dependency property. Inherited from DataControlBase.
ShowLoadingPanelProperty static Identifies the ShowLoadingPanel dependency property. Inherited from DataControlBase.
ShowRowIndicatorProperty static Identifies the ShowRowIndicator dependency property. Inherited from DataControlBase.
ShowSearchPanelModeProperty static Identifies the DataControlBase.ShowSearchPanelMode dependency property. Inherited from DataControlBase.
ShowTotalSummaryProperty static Identifies the DataControlBase.ShowTotalSummary dependency property. Inherited from DataControlBase.
ShowVerticalLinesProperty static Identifies the ShowVerticalLines dependency property. Inherited from DataControlBase.
SummariesIgnoreNullValuesProperty static Identifies the DataControlBase.SummariesIgnoreNullValues dependency property. Inherited from DataControlBase.
TopRowIndexProperty static Identifies the TopRowIndex dependency property. Inherited from DataControlBase.
TotalSummaryItemTemplateProperty static Identifies the DataControlBase.TotalSummaryItemTemplate dependency property. Inherited from DataControlBase.
ValidationErrorProperty static Identifies the DataControlBase.ValidationError dependency property. Inherited from DataControlBase.
VerticalScrollBarVisibilityProperty static Identifies the VerticalScrollBarVisibility dependency property. Inherited from DataControlBase.
VisibleColumnsProperty static Identifies the VisibleColumns dependency property. Inherited from DataControlBase.

Properties

Name Description
ActiveEditor Gets the active editor. This is a dependency property. Inherited from DataControlBase.
ActualGroupCount Gets the actual number of grouping columns.
ActualShowFilterPanel Gets whether the filter panel is displayed within a grid. This is a dependency property. Inherited from DataControlBase.
AllowCommitOnValidationAttributeError Gets or sets whether or not a cell’s value that has failed validation specified by the Data Annotations attribute(s), can be posted to a data source. This is a dependency property. Inherited from DataControlBase.
AllowCopyToClipboard Gets or sets whether to enable copy operations. This is a dependency property. Inherited from DataControlBase.
AllowLeaveInvalidEditor Gets or sets whether an editor that did not pass validation can lose focus. This is a dependency property. Inherited from DataControlBase.
AllowLiveDataShaping Gets or sets whether the GridControl recalculates data shaping operations (for example, sort and filter operations or summary calculation) when you modify a data source outside the grid. Inherited from DataControlBase.
AlternateRowBackground Gets or sets a brush used to paint the background of alternate rows. This is a dependency property. Inherited from DataControlBase.
AlternateRowBackgroundPalette Gets or sets a palette used to paint the background of alternate rows. This is a dependency property. Inherited from DataControlBase.
AlternationCount Gets or sets the alternate row frequency. This is a dependency property. Inherited from DataControlBase.
AutoExpandAllGroups Gets or sets whether all group rows are automatically expanded after each grouping operation. This is a dependency property.
AutoGenerateColumns Gets or sets whether columns should be created automatically for all fields in a data source. This is a dependency property. Inherited from DataControlBase.
AutoScrollOnSorting Gets or sets whether a grid is automatically scrolled after the order of rows has been changed. This is a dependency property. Inherited from DataControlBase.
AutoWidth Gets or sets whether column widths are automatically changed so that the total column width matches the grid width. Inherited from DataControlBase.
CellToolTipShowMode Gets or sets whether to display cell tooltips. This is a dependency property. Inherited from DataControlBase.
ClipboardCopyFormats Gets or sets file formats in which the GridControl copies its data to the clipboard. This is a dependency property. Inherited from DataControlBase.
ColumnMenu Gets or sets a context menu that is invoked when a user right-clicks a column header.
Columns Gets a collection of the GridControl’s columns. Inherited from DataControlBase.
ColumnsSource Gets or sets a source from which the GridControl generates columns. This is a dependency property. Inherited from DataControlBase.
ColumnTemplate Gets or sets a template that describes grid columns. This is a dependency property. Inherited from DataControlBase.
ColumnTemplateSelector Gets or sets a column template selector. This is a dependency property. Inherited from DataControlBase.
Commands Contains grid commands.
CopyColumnHeadersToClipboard Gets or sets whether to add column headers to the clipboard when you copy GridControl data. This is a dependency property. Inherited from DataControlBase.
CurrentColumn Gets or sets a column that contains the focused cell. Inherited from DataControlBase.
CurrentItem Gets or sets the currently focused data row. Inherited from DataControlBase.
CurrentRowHandle Gets or sets the focused row’s handle. Inherited from DataControlBase.
DataContext Gets or sets the control’s data context. Inherited from DataControlBase.
FilterCriteria Gets or sets the grid’s filter criteria. This is a dependency property. Inherited from DataControlBase.
FilteringContext Gets the context that binds a filter item to the GridControl‘s data. Inherited from DataControlBase.
FilterPanelText Gets the text displayed within the Filter Panel. This is a dependency property. Inherited from DataControlBase.
FilterString Gets or sets the grid’s filter expression. This is a dependency property. Inherited from DataControlBase.
FixedSummariesLeft Gets total summaries displayed within the Fixed Summary Panel and aligned to the left. Inherited from DataControlBase.
FixedSummariesRight Gets total summaries displayed within the Fixed Summary Panel and aligned to the right. Inherited from DataControlBase.
FixedTotalSummaryItemTemplate Gets or sets a template that defines the appearance of total summary items in the Fixed Summary Panel. This is a dependency property. Inherited from DataControlBase.
FontFamily Gets or sets the GridControl‘s font family. Inherited from DataControlBase.
FontSize Gets or sets the GridControl‘s font size. Inherited from DataControlBase.
FontStretch Gets or sets the GridControl‘s font stretch. Inherited from DataControlBase.
FontStyle Gets or sets a text style applied to the GridControl. Inherited from DataControlBase.
FontWeight Gets or sets the GridControl‘s font weight. Inherited from DataControlBase.
Foreground Gets or sets a brush that paints the GridControl‘s foreground. Inherited from DataControlBase.
FormatConditions Stores conditional formats applied to the GridControl. Inherited from DataControlBase.
GridMenu Gets or sets a context menu that is invoked when a user right-clicks an empty space within the GridControl.
GroupLevelIndent Gets or sets a width of the group indent.
GroupPanelMenu Gets or sets a context menu that is invoked when a user right-clicks the Group Panel.
GroupRowExpandButtonStyleSettings Gets or sets style settings applied to the group row‘s expand button.
GroupRowExpandButtonTemplate Gets or sets a template that defines the appearance of expand buttons displayed in group rows.
GroupRowMinHeight Gets or sets a group row‘s minimum height.
GroupRowStyleSettings Gets or sets style settings applied to group rows.
GroupSummary Provides access to group summary items.
GroupSummaryDisplayMode Gets or sets the position of group summaries within a group row. This is a dependency property.
GroupSummaryItemTemplate Gets or sets a template that defines the appearance of group summary items. This is a dependency property.
GroupValueTemplate Gets or sets a template that defines the appearance of column values in group rows. This is a dependency property.
HasValidationError Gets whether a validation error has been defined for the grid. This is a dependency property. Inherited from DataControlBase.
HeaderToolTipShowMode Gets or sets whether to display column header tooltips. This is a dependency property. Inherited from DataControlBase.
HighlightRowOnHover Gets or sets whether to highlight a row when a user hovers a mouse pointer over this row. Inherited from DataControlBase.
HorizontalScrollBarVisibility Gets or sets the horizontal scrollbar’s visibility. This is a dependence property. Inherited from DataControlBase.
ImplyNullLikeEmptyStringWhenFiltering Inherited from DataControlBase.
IncrementalLoadingThreshold Gets or sets the threshold range that governs when the grid will begin to prefetch more row items. This is a dependency property. Inherited from DataControlBase.
IsEditing Gets whether the focused cell is currently being edited. This is a dependency property. Inherited from DataControlBase.
IsFilterEnabled Gets or sets whether the current filter is enabled. This is a dependency property. Inherited from DataControlBase.
IsGrouped Gets whether the grid’s data is grouped.
IsGroupPanelVisible Gets whether the Group Panel is displayed in the GridControl. This is a dependency property.
IsSearchPanelVisible Gets whether the GridControl displays the Search Panel. Inherited from DataControlBase.
IsSynchronizedWithCurrentItem Gets or sets whether a grid should keep the DataControlBase.SelectedItem synchronized with the current item in the ICollectionView. This is a dependency property. Inherited from DataControlBase.
ItemsSource Gets or sets the grid’s data source. This is a dependency property. Inherited from DataControlBase.
KeepFocusedRowOnUpdate Gets or sets whether the focused row retains focus when a user sorts or filters GridControl data. This is a dependency property.
LineBrush Gets or sets a brush that paints grid lines. Inherited from DataControlBase.
NavigationStyle Gets or sets whether to allow users to focus rows and cells. This is a dependency property. Inherited from DataControlBase.
NewItemRowPosition Gets or sets the New Item Row‘s position within the grid. This is a dependency property. Inherited from DataControlBase.
PasteMode Gets or sets how to paste rows from the clipboard to the GridControl. This is a dependency property. Inherited from DataControlBase.
PredefinedFormats Contains predefined formats used in conditional formatting rules. This is a dependency property. Inherited from DataControlBase.
PreserveSorting Gets or sets whether clicking a column header clears the existing sort settings. This is a dependency property. Inherited from DataControlBase.
PrintAllGroupsExpanded Gets or sets whether to print the grid with all group rows expanded. This is a dependency property.
PrintAutoWidth Gets or sets whether columns should fit to the report page in a printed document. This is a dependency property.
PrintColumnHeaders Gets or sets whether to print column headers. This is a dependency property.
PrintColumnHeaderStyle Gets or sets the style applied to column header items in a printed document. This is a dependency property.
PrintFixedTotalSummary Gets or sets whether to print the fixed total summary panel. This is a dependency property.
PrintFixedTotalSummaryStyle Gets or sets the style applied to fixed total summary items in a printed document. This is a dependency property.
PrintGroupLevelIndent Gets or sets the indent between group rows at neighboring group levels when the GridControl is printed. This is a dependency property.
PrintGroupRowStyle Gets or sets the style applied to group row items (including Group Summary) in a printed document. This is a dependency property.
PrintGroupSummary Gets or sets whether to print the group summary panel. This is a dependency property.
PrintTotalSummary Gets or sets whether to print the summary panel. This is a dependency property.
PrintTotalSummaryStyle Gets or sets the style applied to total summary items when they are printed. This is a dependency property.
RowCellMenu Gets or sets a context menu that is invoked when a user right-clicks a data cell, a row, or row indicator cells.
RowIndicatorHeaderTemplate Gets or sets a template that defines the appearance of the row indicator header. Inherited from DataControlBase.
RowIndicatorStyleSettings Gets or sets style settings applied to the Row Indicator Panel. Inherited from DataControlBase.
RowIndicatorTemplate Gets or sets a template that defines the appearance of row indicator cells. Inherited from DataControlBase.
RowIndicatorWidth Gets or sets the width of the Row Indicator Panel. Inherited from DataControlBase.
RowMinHeight Gets or sets a data row’s minimum height. Inherited from DataControlBase.
RowStyleSettings Gets or sets style settings applied to grid rows. Inherited from DataControlBase.
SearchColumns Gets or sets the field names against which searches are performed by the Search Panel. This is a dependency property. Inherited from DataControlBase.
SearchDelay Gets or sets the amount of time in milliseconds, after which a data search is initiated (in an automatic find mode). This is a dependency property. Inherited from DataControlBase.
SearchPanelAllowFilter Gets or sets whether the grid displays only those records that match the search criteria. This is a dependency property. Inherited from DataControlBase.
SearchPanelClearOnClose Gets or sets whether to clear the search string when the Search Panel is closed. This is a dependency property. Inherited from DataControlBase.
SearchPanelCriteriaOperatorType Gets or sets the logical operator type (AND or OR). This is a dependency property. Inherited from DataControlBase.
SearchPanelFindFilter Gets or sets the type of the comparison operator used to create filter conditions. This is a dependency property. Inherited from DataControlBase.
SearchPanelFindMode Gets or sets whether data searching starts automatically, or must be started manually. This is a dependency property. Inherited from DataControlBase.
SearchPanelHighlightResults Gets or sets whether to highlight search results within located records. This is a dependency property. Inherited from DataControlBase.
SearchPanelHighlightSettings Gets or sets settings applied to search results. Inherited from DataControlBase.
SearchString Gets or sets the search string specified within the Search Panel. This is a dependency property. Inherited from DataControlBase.
SelectedItem Get or sets the currently focused data item. Inherited from DataControlBase.
SelectedItems Gets data objects that correspond to items currently selected within a grid. Inherited from DataControlBase.
SelectionMode Gets or sets whether multiple row/cell selection is enabled. This is a dependency property. Inherited from DataControlBase.
ShowAutoFilterRow Gets or sets whether to display the Automatic Filter Row. Inherited from DataControlBase.
ShowColumnHeaders Gets or sets whether a grid displays column headers. This is a dependency property. Inherited from DataControlBase.
ShowFilterPanelMode Gets or sets when the Filter Panel is displayed within a grid. This is a dependency property. Inherited from DataControlBase.
ShowFixedTotalSummary Gets or sets whether or not the Fixed Summary Panel is displayed within the grid. This is a dependency property. Inherited from DataControlBase.
ShowGroupedColumns Gets or sets whether to display grouped columns in the GridControl. This is a dependency property.
ShowGroupPanel Gets or sets whether to display the Group Panel. This is a dependency property.
ShowGroupRowExpandButton Gets or sets whether to display expand buttons in group rows.
ShowHorizontalLines Gets or sets whether to display horizontal grid lines. Inherited from DataControlBase.
ShowLoadingPanel Gets or sets whether to display the Loading Panel in the GridControl when it waits for a callback response. This is a dependency property. Inherited from DataControlBase.
ShowRowIndicator Gets or sets whether to display the Row Indicator Panel. Inherited from DataControlBase.
ShowSearchPanelMode Gets or sets when the Search Panel is shown within the grid. This is a dependency property. Inherited from DataControlBase.
ShowTotalSummary Gets or sets whether to display the total summary panel. Inherited from DataControlBase.
ShowVerticalLines Gets or sets whether to display vertical grid lines. Inherited from DataControlBase.
SummariesIgnoreNullValues Gets or sets whether null values must be ignored when calculating data summaries. This is a dependency property. Inherited from DataControlBase.
TopRowIndex Gets or sets the index of the top visible row. Inherited from DataControlBase.
TotalSummary Provides access to a collection of total summary items.
TotalSummaryItemTemplate Gets or sets the template that defines the presentation of total summary items. This is a dependency property. Inherited from DataControlBase.
ValidationError Provides access to the object, which contains information about the validation error. This is a dependency property. Inherited from DataControlBase.
VerticalScrollBarVisibility Gets or sets the vertical scrollbar’s visibility. This is a dependence property. Inherited from DataControlBase.
VisibleColumns Gets a list of visible columns. This is a dependency property. Inherited from DataControlBase.
VisibleRowCount Gets the total number of rows displayed in the GridControl.

Methods

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.

Events

Name Description
AddingNewRow Fires before a new row is added to the data source via the Grid.
AutoGeneratedColumns Occurs after the columns have been automatically generated. Inherited from DataControlBase.
AutoGeneratingColumn Occurs each time an individual column is auto-generated. Inherited from DataControlBase.
CellValueChanged Occurs when a cell value is changed.
CellValueChanging Occurs when a user edits a cell value (for example, types or deletes a character, or chooses a value from the drop-down list).
ClipboardRowCopying Occurs before the GridControl copies data to the clipboard and allows you to process the copy operation.
ClipboardRowPasting Occurs before clipboard data is pasted in the GridControl and allows you to process the paste operation.
ContextMenuClosed Occurs after a user closes a context menu.
ContextMenuOpened Occurs after a user opens a context menu.
ContextMenuOpening Occurs before a user opens a context menu.
CurrentColumnChanged Occurs after the focused column has been changed. Inherited from DataControlBase.
CurrentItemChanged Occurs after the focused row is changed. Inherited from DataControlBase.
CustomCellAppearance Allows you to customize cell appearance. Inherited from DataControlBase.
CustomColumnDisplayText Allows you to customize a data cell’s display text.
CustomColumnGroup Provides the capability to group data using custom rules.
CustomColumnSort Enables you to sort data using custom rules.
CustomGroupDisplayText Allows you to display custom text in group rows.
CustomRowFilter Allows you to use custom rules to filter data rows.
CustomSummary Allows you to calculate summary values manually.
CustomSummaryExists Enables you to specify which summaries should be calculated and displayed.
CustomUnboundColumnData Enables data to be supplied to unbound columns.
CustomUniqueValues Allows you to specify unique values displayed in a column’s drop-down filter. Inherited from DataControlBase.
EndGrouping Occurs after the grouping operation has been completed.
EndSorting Occurs after a sorting operation has been completed.
FilterChanged Occurs after the grid’s filter has been changed. Inherited from DataControlBase.
GroupRowCollapsed Occurs after a group row has been collapsed.
GroupRowCollapsing Occurs when a group row is about to be collapsed, allowing cancellation of the action.
GroupRowExpanded Occurs after a group row has been expanded.
GroupRowExpanding Occurs when a group row is about to be expanded, allowing cancellation of the action.
HiddenEditor Occurs after a cell’s editor is closed.
InitNewRow Allows you to initialize a new row with default values.
InvalidRowException Occurs when a row fails validation or cannot be saved to a data source.
ItemsSourceChanged Occurs after the DataControlBase.ItemsSource property has been changed. Inherited from DataControlBase.
RowCanceled Occurs when the changes made in a row are discarded.
RowUpdated Occurs when the GridControl updates the data source with the changes made within the focused row.
SelectionChanged Occurs after grid’s selection is changed.
ShowFilterPopup Enables you to customize a column’s drop-down filter. Inherited from DataControlBase.
ShownEditor Occurs after the focused cell’s editor is shown.
StartGrouping Occurs before a grouping operation is started.
StartSorting Occurs before a sorting operation is started.
ValidateCell Enables you to specify whether the focused cell’s data is valid, and whether the cell’s editor can be closed.
ValidateRow Allows you to validate row values.
See Also