Back to Devexpress

DevExpress.Xpf.Grid Namespace

wpf-devexpress-dot-xpf.md

latest55.6 KB
Original Source

DevExpress.Xpf.Grid Namespace

Contains classes which implement the main functionality of the DXGrid for WPF suite. To use these classes in XAML code, add the xmlns:dxg=”http://schemas.devexpress.com/winfx/2008/xaml/grid“ namespace reference.

Assemblies : DevExpress.Xpf.Grid.v25.2.dll, DevExpress.Xpf.Grid.v25.2.Core.dll, DevExpress.Xpf.Grid.v25.2.Extensions.dll

NuGet Package : DevExpress.Wpf.Grid.Core

Classes

NameDescription
ActivationActionEventArgsBaseProvides data for the DataViewBase.GetIsEditorActivationAction and DataViewBase.ProcessEditorActivationAction events.
BandBaseServes as a base class for bands.
BaseColumnServes as a base for classes that represent columns or card fields.
BaseGridColumnHeaderThe base class for grid column headers.
BaseGridHeaderThe base class for grid column headers.
CanSelectCellEventArgsProvides data for the TableView.CanSelectCell and TreeListView.CanSelectCell events.
CanSelectRowEventArgsProvides data for the DataViewBase.CanSelectRow event.
CanUnselectCellEventArgsProvides data for the TableView.CanUnselectCell and TreeListView.CanUnselectCell events.
CanUnselectRowEventArgsProvides data for the DataViewBase.CanUnselectRow event.
CardDataContains information about a card.
CardHeaderDataContains a card header’s data.
CardViewRepresents a View that displays data using cards.
CardViewCommandsProvides access to the CardView‘s built-in commands.
CardViewHitInfoContains information about the specified element contained within the Card View.
CellContentPresenterDisplays the content of a data cell.
CellEditorValueChangingEventArgsContains data for the CellEditorValueChanging event.
CellMergeEventArgsProvides data for the TableView.CellMerge event.
CellValueChangedEventArgsProvides data for the GridViewBase.CellValueChanged event.
CellValueChangedInEditFormEventArgsContains data for the CellValueChanging event that occurs when a user edits data in the Edit Form.
CellValueEventArgsProvides data for the GridViewBase.CellValueChanging and GridViewBase.CellValueChanged events.
ClipboardRowCellValuePastingEventArgsProvides data for the TableView.ClipboardRowCellValuePasting and TreeListView.ClipboardRowCellValuePasting events.
ClipboardRowCopyingEventArgsProvides data for the TableView.ClipboardRowCopying / TreeListView.ClipboardNodeCopying events.
ClipboardRowPastingEventArgsProvides data for the TableView.ClipboardRowPasting and TreeListView.ClipboardRowPasting events.
ColorScaleFormatConditionA Color Scales conditional format.
ColumnBaseServes as a base for classes that represent columns or card fields.
ColumnChooserControlThe legacy Column Chooser control allows users to show and hide the GridControl‘s columns at runtime.
ColumnCollectionBase<TColumn>The base class for column collections.
ColumnDataEventArgsBaseServes as a base for classes that provide data for events used to supply data for unbound columns.
ColumnHeaderClickEventArgsProvides data for the DataViewBase.ColumnHeaderClick event.
CompactModeFilterItemRepresents a filter item displayed within the compact panel in compact mode.
ContentDetailDescriptorRepresents a Detail with freely-customizable content.
CopyingToClipboardEventArgsProvides data for the GridControl.CopyingToClipboard event.
CopyingToClipboardEventArgsBaseServes as the base class for classes that provide data for events related to copying data to the clipboard.
CurrentItemChangedEventArgsProvides data for the DataControlBase.CurrentItemChanged event.
CustomBestFitEventArgsProvides data for the TableView.CustomBestFit event.
CustomBestFitEventArgsBaseServes as the base class for classes that provide data for events related to changing the column’s width.
CustomCellAppearanceEventArgsProvides data for the TableView.CustomCellAppearance and TreeListView.CustomCellAppearance events.
CustomColumnDisplayTextEventArgsProvides data for the GridControl.CustomColumnDisplayText event.
CustomColumnSortEventArgsProvides data for the GridControl.CustomColumnSort event.
CustomDataUpdateFormatConditionEventArgsProvides data for the TableView.CustomDataUpdateFormatCondition and TreeListView.CustomDataUpdateFormatCondition events.
CustomFilterDisplayTextEventArgsProvides data for the DataViewBase.CustomFilterDisplayText event.
CustomGroupDisplayTextEventArgsProvides data for the GridControl.CustomGroupDisplayText event.
CustomRowAppearanceEventArgsProvides data for the TableView.CustomRowAppearance and TreeListView.CustomRowAppearance events.
CustomUniqueValuesEventArgsProvides data for the CustomUniqueValues event.
DataBarFormatConditionA Data Bars conditional format.
DataControlBaseServes as a base for classes that represents data-aware controls (e.g. GridControl).
DataControlDetailDescriptorRepresents a detail that displays a grid control and natively integrates with the master grid.
DataControlSerializationOptionsContains options that specify how column specific settings are stored to and restored from a stream or file in XML format.
DataSourceRefreshEventArgsProvides data for the DataSourceRefresh event.
DataUpdateFormatConditionA Data Update conditional format.
DataViewBaseServes as a base for classes that represent Views.
DataViewCommandsBaseContains built-in commands common to all the GridControl views.
DefaultColumnMenuItemNamesContains default item captions displayed within the column context menu.
DefaultColumnMenuItemNamesBase
DefaultSummaryMenuItemNamesContains default item captions displayed within the summary context menu.
DetailDescriptorBaseImplements the basic functionality for objects that represent Detail Views within the grid’s master-detail hierarchy.
DetailDescriptorCollectionStores a collection of Detail Descriptors.
DetailDescriptorSelectorEnables you to select which detail descriptor to use in data dependent details.
DetailDescriptorTriggerRepresents a trigger that selects a proper detail for each master row conditionally.
DialogEditFormBehaviorAllows you to enable edit operations in a Data Grid bound to a Server Mode or Instant Feedback data source.
EditFormShowingEventArgsProvides data for the TableView.EditFormShowing and TreeListView.EditFormShowing events.
EditGridCellDataContains information about a data cell in edit mode.
EditorEventArgsProvides data for the GridViewBase.ShownEditor and GridViewBase.HiddenEditor event.
EditorEventArgsBaseServes as the base class for all classes that provide data for different events, related to using in-place editors.
ExcelColumnFilterSettingsContains settings specific to an Excel-style column filter.
ExpressionConditionBaseServes as a base class for expression based conditional formats.
ExtendedColumnChooserControlThe Column Chooser control allows users to show and hide the GridControl‘s columns at runtime.
FilterCellContentPresenterDisplays the content of a automatic filter row cell.
FilterEditorEventArgsProvides data for the DataViewBase.FilterEditorCreated event.
FilterGroupSortChangingEventArgsProvides data for the DataControlBase.FilterGroupSortChanging event.
FilterPopupEventArgsProvides data for the DataViewBase.ShowFilterPopup event.
FocusedRowChangedEventArgsProvides data for the DataViewBase.FocusedRowChanged event. The DataViewBase.FocusedRowChanged event is obsolete. Use DataControlBase.CurrentItemChanged instead.
FocusedRowHandleChangedEventArgsProvides data for the DataViewBase.FocusedRowHandleChanged event.
FocusedRowHandleChangingEventArgsContains data for the FocusedRowHandleChanging event.
FormatConditionA value based conditional format.
FormatConditionBaseServes as a base class for conditional formats.
FormatConditionCollectionA collection of conditional formats.
GetActiveEditorNeedsKeyEventArgsProvides data for the DataViewBase.GetActiveEditorNeedsKey event.
GetIsEditorActivationActionEventArgsProvides data for the DataViewBase.GetIsEditorActivationAction event.
GridBandMenuInfoContains information about a context menu invoked for a grid band.
GridCellRepresents an object which corresponds to a data cell.
GridCellDataContains information about a data cell.
GridCellValidationEventArgsProvides data for the GridColumn.Validate event.
GridColumnThe grid column.
GridColumnCollectionRepresents the grid’s column collection.
GridColumnCommandsProvides access to column commands.
GridColumnData

Contains information about a column.

This class supports the internal infrastructure and is not intended to be used directly from your code.

| | GridColumnDataEventArgs | Provides data for the GridControl.CustomUnboundColumnData event. | | GridColumnHeader | Represents a column’s header. | | GridColumnHeaderBase | Represents the base class for a grid column header. | | GridCommands static | Provides access to built-in grid commands. | | GridControl | The Data Grid control. | | GridControlBand | The grid band. | | GridControlBandsLayout | This class supports the internal infrastructure and is not intended to be used directly from your code. | | GridControlLocalizer | A base class that provides necessary functionality for custom localizers of the Data Grid control. | | GridDataBase | Serves as a base for classes that provide information about grid elements (cells, columns, etc.). | | GridDataViewBase | Serves as a base for classes that represent Views. | | GridGroupSummaryData | Contains information about the summary value displayed within a group row. | | GridGroupSummarySortInfo | Represents an element in the GridGroupSummarySortInfoCollection. | | GridGroupSummarySortInfoCollection | Represents a collection which contains the information required to sort the group rows by summary values. | | GridGroupValueData | Contains information about group row values. | | GridMenuEventArgs | Provides data for the DataViewBase.ShowGridMenu event. | | GridMenuInfo | Contains information about the context menu. | | GridPopupMenu | A pop-up menu displayed within a View. | | GridRowContent | Displays the content of a data row. | | GridRowInfo | Contains information about the grid’s row. | | GridRowValidationEventArgs | Populates the GridViewBase.ValidateRow event handler with data. | | GridSelectionChangedEventArgs | Provides data for the GridControl.SelectionChanged event. | | GridSerializationOptions | Contains options that specify how column specific settings are stored to and restored from a stream or file in XML format. | | GridSortInfo | Represents an element in the GridControl.SortInfo collection. | | GridSortInfoCollection | Represents a collection of GridSortInfo objects. | | GridSummaryData | Contains information about the summary value. | | GridSummaryItem | Represents a summary item. | | GridSummaryItemCollection | A collection of summary items. | | GridTotalSummaryData | Contains information about the total summary value displayed within the Summary Panel. | | GridValidateRowDeletionEventArgs | Provides data for the ValidateRowDeletion event. | | GridViewBase | Serves as the base for objects representing Table and Card views in a grid control. | | GridViewCommandsBase | Provides access to View commands. | | GridViewHitInfoBase | Serves as the base for classes providing information about a particular view element. | | GroupRowControl | A grid group row. | | GroupRowData | Contains information about a group row. | | HeadersData | Contains information about column headers. | | IconSetFormatCondition | An Icon Sets conditional format. | | IndicatorFormatConditionBase | Serves as a base class for indicator-type conditional formats. | | InitNewRowEventArgs | Provides data for the TableView.InitNewRow event. | | InvalidRowExceptionEventArgs | Provides data for the GridViewBase.InvalidRowException event. | | LightweightCellEditor | Displays the content of a data cell in the optimized mode. | | LightweightCellEditorBase | Serves as the base for classes that display the content of a data cell in the optimized mode. | | MultiDetailDescriptor | Serves as the base for Detail Descriptors that allow you to display multiple details at the same level. | | ProcessEditorActivationActionEventArgs | Provides data for the DataViewBase.ProcessEditorActivationAction event. | | RowAllowEventArgs | Provides data for the GridControl.GroupRowExpanding and GridControl.GroupRowCollapsing events. | | RowControl | A grid row. | | RowData | Contains information about a data row. | | RowDataBase | Serves as a base for classes that contain information about rows and cards. | | RowDoubleClickEventArgs | Provides data for the TableView.RowDoubleClick event handler. | | RowEditFinishedEventArgs | Contains data for the RowEditFinished event. | | RowEditStartedEventArgs | Contains data for the RowEditStarted event. | | RowEditStartingEventArgs | Contains data for the RowEditStarting event. | | RowEventArgs | Provides data for the GridControl.GroupRowExpanded, GridControl.GroupRowCollapsed, GridViewBase.RowUpdated and GridViewBase.RowCanceled events. | | ScrollBarAnnotationInfo | Contains information about the layout and appearance of a particular type of scrollbar annotation marks. | | ScrollBarAnnotationRowInfo | Contains information about scrollbar annotation. | | ScrollBarAnnotationsAppearance | Contains properties that provide access to the appearance settings of particular scrollbar annotation marks. | | ScrollBarAnnotationsCreatingEventArgs | Provides data for the TableView.ScrollBarAnnotationsCreating and TreeListView.ScrollBarAnnotationsCreating events. | | ScrollBarCustomRowAnnotationEventArgs | Provides data for the TableView.ScrollBarCustomRowAnnotation and TreeListView.ScrollBarCustomRowAnnotation events. | | SearchStringToFilterCriteriaEventArgs | Provides data for the DataViewBase.SearchStringToFilterCriteria event. | | SelectedRowsCollection | Represents a collection of selected rows. | | ShowingEditorEventArgs | Provides data for the GridViewBase.ShowingEditor event. | | ShowingEditorEventArgsBase | Serves as the base for classes that provide data for events related to showing in-place editors. | | SummaryItemBase | Serves as a base for classes that represent summary items. | | SummaryItemCollectionBase<T> | The base class for summary item collections. | | TableView | A View that displays data in a tabular form. | | TableViewCommands | Provides access to the TableView‘s built-in commands. | | TableViewHitInfo | Contains information about the specified element contained within the Table View. | | TabViewDetailDescriptor | Displays multiple Details within a tabbed container. | | TopBottomRuleFormatCondition | Represents the Top-Bottom and Average conditional formats. | | TreeListBandMenuInfo | Contains information about a context menu invoked for a treelist band. | | TreeListColumn | A column within a TreeListControl. | | TreeListColumnCollection | The treelist’s column collection. | | TreeListControl | The TreeList control. | | TreeListControlBand | The treelist band. | | TreeListControlBandsLayout | This class supports the internal infrastructure and is not intended to be used directly from your code. | | TreeListControlBase | Serves as a base class for the TreeListControl and the TreeViewControl. | | TreeListNode | A node displayed within a TreeListView. | | TreeListNodeCollection | A collection of nodes. | | TreeListNodeIterator | The Node Iterator. | | TreeListNodeSummaryItemCollection | A collection of node summary items. | | TreeListRowInfo | Contains information about the treelist’s row. | | TreeListSortInfoCollection | A collection of GridSortInfo objects. | | TreeListSummaryItem | A summary item. | | TreeListSummaryItemCollection | A collection of summary items. | | TreeListView | A View that displays information in a tree hierarchical structure. | | TreeListViewCommands | Provides access to the TreeListView‘s built-in commands. | | TreeViewControl | The TreeView control. | | UnboundExpressionEditorEventArgs | Provides data for the DataViewBase.UnboundExpressionEditorCreated event. | | UniqueDuplicateRuleFormatCondition | A Unique-Duplicate conditional format. |

Interfaces

NameDescription
IAsyncChildNodesSelectorThe interface that allows you to create an asynchronous child nodes selector.
IChildNodesSelectorThe interface that allows you to create a child nodes selector.

Structs

NameDescription
GridColumnWidthRepresents the width of the columns in the GridControl.

Delegates

NameDescription
CellValueChangedEventHandlerRepresents a method that will handle the GridViewBase.CellValueChanged event.
CellValueEventHandlerRepresents a method that will handle the GridViewBase.CellValueChanging and GridViewBase.CellValueChanged events.
CopyingToClipboardEventHandlerRepresents a method that will handle the GridViewControl.CopyingToClipboard event.
CustomBestFitEventHandlerRepresents a method that will handle the TableView.CustomBestFit event.
CustomColumnDisplayTextEventHandlerRepresents a method that will handle the GridControl.CustomColumnDisplayText event.
CustomColumnSortEventHandlerRepresents a method that will handle the GridControl.CustomColumnSort and GridControl.CustomColumnGroup events.
CustomFilterDisplayTextEventHandlerRepresents a method that will handle the DataViewBase.CustomFilterDisplayText event.
CustomGroupDisplayTextEventHandlerRepresents a method that will handle the GridControl.CustomGroupDisplayText event.
EditorEventHandlerRepresents a method that will handle the GridViewBase.ShownEditor and GridViewBase.HiddenEditor events.
FilterEditorEventHandlerRepresents a method that will handle the DataViewBase.FilterEditorCreated event.
FilterPopupEventHandlerRepresents a method that will handle the DataViewBase.ShowFilterPopup event.
FocusedRowChangedEventHandlerRepresents a method that will handle the DataViewBase.FocusedRowChanged event.
GridCellValidationEventHandlerRepresents a method that will handle the GridColumn.Validate event.
GridColumnDataEventHandlerRepresents a method that will handle the GridControl.CustomUnboundColumnData event.
GridMenuEventHandlerRepresents a method that will handle the DataViewBase.ShowGridMenu event.
GridRowValidationEventHandlerRepresents a method that will handle the GridViewBase.ValidateRow event.
GridSelectionChangedEventHandlerRepresents a method that will handle the GridViewBase.SelectionChanged event.
InitNewRowEventHandlerRepresents a method that will handle the TableView.InitNewRow event.
InvalidRowExceptionEventHandlerRepresents a method that will handle the GridViewBase.InvalidRowException event.
RowAllowEventHandlerRepresents a method that will handle the GridControl.GroupRowExpanding and GridControl.GroupRowCollapsing events.
RowDoubleClickEventHandlerA method that will handle the TableView.RowDoubleClick and TreeListView.RowDoubleClick events.
RowEventHandlerRepresents a method that will handle the GridViewBase.RowUpdated, GridViewBase.RowCanceled, GridControl.GroupRowExpanded and GridControl.GroupRowCollapsed events.
ShowingEditorEventHandlerRepresents a method that will handle the GridViewBase.ShowingEditor event.
UnboundExpressionEditorEventHandlerRepresents a method that will handle the DataViewBase.UnboundExpressionEditorCreated event.

Enums

NameDescription
AllowedAnyOfFiltersLists the possible any of filters that the GridControl ‘s column supports.
AllowedBetweenFiltersLists the possible between filters that the GridControl ‘s column supports.
AllowedBinaryFiltersLists the possible binary filters that the GridControl ‘s column supports.
AllowedDateTimeFiltersLists the possible date-time filters that the GridControl ‘s column supports.
AllowedTotalSummariesLists the possible total summaries.
AllowedUnaryFiltersLists the possible unary filters that the GridControl ‘s column supports.
AllowFilterEditorAggregateOperandsLists values that specify whether users can create aggregate filters.
AutoFilterConditionLists values that specify the type of the comparison operator used to create filter conditions within the Automatic Filter Row.
AutoFilterRowClearButtonModeContains values that specify the visibility of the clear button in the Automatic Filter Row.
AutoFilterRowPositionLists values that specify where to display the Automatic Filter Row.
AutoGenerateColumnsModeLists the values used to specify how columns are generated.
BestFitAreaLists the values used to specify which interface elements should be taken into account when adjusting the column width.
CardLayoutLists values that specify how cards are arranged within a Card View.
CardViewHitTestLists values which identify card view elements.
CardViewSelectModeLists values that specify the selection mode in a Card View.
ClipboardCopyModeLists the values that specify the clipboard copy mode.
ClipboardCopyOptionsLists the formats with which the data copied from the GridControl should be compatible.
ClipboardModeLists the values that specify whether the grid cell data is copied together with the format settings.
ColumnChooserColumnDisplayModeLists values that specify how the column chooser displays columns.
ColumnFilterModeLists values that specify how column values are filtered.
ColumnFilterPopupModeLists values that specify the display mode of the Drop-Down Filter for all columns within the view.
ColumnPositionLists values that specify a column’s position within a View.
ColumnSortClearModeLists the possible modes of clearing sorting.
CompactFilterElementShowModeLists the values that specify how the grid’s filter is displayed in compact mode.
CompactPanelShowModeLists the values that specify the compact panel show mode.
CompactSortElementShowModeLists the values that specify how sort elements are displayed within the compact panel.
DeleteKeyBehaviorLists actions executed when a user presses the Delete key.
EditFormPostModeLists values that specify whether changes made to a row in the Inline Edit Form are immediately shown within the grid.
EditFormShowModeLists values that specify the Edit Form‘s show mode.
EditorButtonShowModeLists values that specify which cells should display editor buttons.
ErrorsWatchModeLists values that specify the errors watch mode.
ExcelColumnFilterTypeLists the possible Excel column filter types.
ExceptionModeLists values that specify how to handle an exception.
FilterPopupModeLists values that specify the display mode of a column’s Drop-Down Filter.
FixedRowPositionLists the values that specify the position of the fixed row within the grid.
FixedStyleLists values that specify a column/band’s behavior when a view is horizontally scrolled.
GridColumnUnitTypeLists the values that are used to specify the BaseColumn.Width property.
GridControlRuntimeStringIdLists resource strings that can be localized at runtime.
GridControlStringIdContains values corresponding to strings that can be localized.
GridMenuTypeLists values that specify the context menu type.
GridSummaryCalculationModeLists the values that specify the DataViewBase.SummaryCalculationMode and SummaryItemBase.CalculationMode properties.
GridSummaryItemAlignmentLists values that specify a summary item’s horizontal alignment within the Fixed Summary Panel.
GridViewNavigationStyleLists values that specify whether row and cell focusing is allowed.
GroupSummaryDisplayModeLists values that specify the alignment (position) of group summaries within a group row.
HeaderPositionLists the values that specify the grid view’s header position.
HeaderPresenterTypeLists values that specify which grid element contains a column’s header.
IncrementalSearchModeLists values that specify the incremental search mode.
IndicatorStateLists the values used to indicate the row indicator state.
MergedGroupingModeLists values that specify merged grouping modes.
MergeGroupPositionEnumerates values that specify the position of merged group headers.
MultiCellEditModeLists values that specify the cell range for multi-cell edit operations.
MultiSelectModeLists values that specify the selection mode.
NavigationTypeLists user actions that lead to focus change.
NavigatorButtonTypeSpecifies the options for displaying buttons within the Data Navigator.
NewItemRowPositionLists values that specify the New Item Row‘s position within a View.
PostConfirmationModeLists values that specify the response to an end-user’s attempt to move the focus from the Edit Form while it contains unsaved changes.
RowAnimationKindLists values that specify what animation is played while data rows are being asynchronously retrieved by the data source.
RowDetailsVisibilityModeLists values that specify when GridControl row details are displayed.
RowFixingPositionLists values that specify the available fixed row positions.
RowPositionLists values that specify a row’s position within a View.
ScrollAnimationModeLists per-pixel scrolling modes.
ScrollBarAnnotationAlignmentLists values that specify the alignment of scrollbar annotation marks.
ScrollBarAnnotationModeList values that specify the scrollbar annotation modes.
ScrollingModeLists values that specify how many rows are displayed onscreen when a View is scrolled to the bottom.
ScrollModeLists values that specify the scrolling mode for CardView.
SearchPanelPositionLists the values that specify the GridViewBase.SearchPanelPosition property.
SelectionStateLists values that specify a cell’s (or row’s) selection state.
SelectorColumnPositionLists all available checkbox selector column positions.
ShowFilterPanelModeLists values that specify when a View displays the Filter Panel.
ShowFixRowButtonLists values that specify the availability and behavior of the fix row buttons.
ShowSearchPanelModeLists values that specify when the Search Panel is displayed.
ShowUpdateRowButtonsLists the values that specify the TableView.ShowUpdateRowButtons and TreeListView.ShowUpdateRowButtons properties.
TableViewHitTestLists values which identify table view elements.
TableViewSelectModeLists values that specify the selection mode in a Table View.
TotalSummaryPositionLists values that specify the Summary Panel‘s position in a View.
TreeDerivationModeLists values that specify the tree derivation mode.
TreeListFilteringModeLists the values that specify the TreeListView.FilteringMode property.
TreeListFilterModeLists the values that specify the TreeListView.FilterMode property.
TreeListLineStyleLists values that specify the style of tree lines used to connect nodes.
UseCardLightweightTemplatesLists values that specify whether to enable the lightweight templates feature.
UseLightweightTemplatesLists values that specify whether to enable the lightweight templates feature.
WaitIndicatorTypeLists values that specify how async data loading operations are indicated