Back to Devexpress

DevExpress.XtraPivotGrid Namespace

windowsforms-devexpress-eb466195.md

latest42.0 KB
Original Source

DevExpress.XtraPivotGrid Namespace

Contains classes which implement the main functionality of the PivotGridControl.

Assemblies : DevExpress.XtraEditors.v25.2.dll, DevExpress.XtraPivotGrid.v25.2.dll

NuGet Packages : DevExpress.Win.Navigation, DevExpress.Win.PivotGrid

Classes

NameDescription
CancelPivotCellEditEventArgsProvides data for the PivotGridControl.ShowingEditor event.
CustomCustomizationFormSortEventArgsProvides data for the PivotGridControl.CustomCustomizationFormSort event.
CustomEditValueEventArgsProvides data for the PivotGridControl.CustomEditValue event.
CustomExportCellEventArgsProvides data for the PivotGridControl.CustomExportCell event.
CustomExportFieldValueEventArgsProvides data for the PivotGridControl.CustomExportFieldValue event.
CustomExportHeaderEventArgsProvides data for the PivotGridControl.CustomExportHeader event.
CustomFieldDataEventArgsProvides data for the PivotGridControl.CustomUnboundFieldData event.
CustomizationFormShowingEventArgsProvides data for the PivotGridControl.ShowingCustomizationForm event.
CustomizePivotCellEventArgsProvides data for the PivotXlsExportOptions.CustomizeCell and PivotXlsxExportOptions.CustomizeCell events.
CustomServerModeSortEventArgsProvides data for the PivotGridControl.CustomServerModeSort event
DataSourceColumnBindingDefines a data binding to a source data column.
DifferenceBindingDefines the difference calculation between values across a window.
EditValueChangedEventArgsProvides data for the PivotGridControl.EditValueChanged event.
ExpressionDataBindingDefines a calculation based on a string expression.
FieldValueCellRepresents a field value cell.
FilterPopupExcelCustomizeTemplateEventArgsProvides data for the PivotGridControl.FilterPopupExcelCustomizeTemplate event.
FilterPopupExcelDataEventArgsProvides data for the PivotGridControl.FilterPopupExcelData event.
FilterPopupExcelEventArgsProvides data for the PivotGridControl.ShowFilterPopupExcel event.
FilterPopupExcelParseFilterCriteriaEventArgsProvides data for the FilterPopupExcelParseFilterCriteria event.
FilterPopupExcelPrepareTemplateEventArgsProvides data for the PivotGridControl.FilterPopupExcelPrepareTemplate event.
FilterPopupExcelQueryFilterCriteriaEventArgsProvides data for the PivotGridControl.FilterPopupExcelQueryFilterCriteria event.
FormatRuleFieldIntersectionSettingsContains format rule settings used to apply conditional formatting to data cells placed at the intersection of specified column and row fields.
FormatRuleSettingsServes as the base class for classes that provide format rule settings used to apply conditional formatting to data cells.
FormatRuleTotalTypeSettingsContains format rule settings used to apply conditional formatting to various types of data cells (data cells, custom total cells, grand total cells, and total cells).
MovingCalculationBindingDefines aggregations across a specified number of values before and/or after the current value.
OLAPExpressionBindingGets or sets an expression that is used to evaluate values for a Pivot Grid’s field in OLAP mode.
PercentOfTotalBindingDefines the calculation of a percentage of all values in the window.
PivotAreaChangingEventArgsProvides data for the PivotGridControl.FieldAreaChanging event.
PivotCellBaseEventArgsProvides data for the events which are invoked for particular data cells.
PivotCellDisplayTextEventArgsProvides data for the PivotGridControl.CustomCellDisplayText event.
PivotCellEditEventArgsProvides data for the PivotGridControl.HiddenEditor and PivotGridControl.ShownEditor events.
PivotCellEventArgsProvides data for the PivotGridControl.CellClick and PivotGridControl.CellDoubleClick events.
PivotCellValueEventArgsProvides data for the PivotGridControl.CustomCellValue event.
PivotCustomAppearanceEventArgsProvides data for the PivotGridControl.CustomAppearance event.
PivotCustomAppearanceThreadSafeEventArgsProvides thread-safe access to the PivotGridControl.CustomAppearance event data.
PivotCustomCellEditEventArgsProvides data for the PivotGridControl.CustomCellEdit event.
PivotCustomChartDataSourceDataEventArgsProvides data for the PivotGridControl.CustomChartDataSourceData event.
PivotCustomChartDataSourceRowsEventArgsProvides data for the PivotGridControl.CustomChartDataSourceRows event.
PivotCustomColumnWidthEventArgsProvides data for the PivotGridControl.CustomColumnWidth event.
PivotCustomDrawBaseThreadSafeEventArgsProvides thread-safe access to custom painting events data.
PivotCustomDrawCellBaseEventArgsProvides data for custom painting events invoked for particular data cells.
PivotCustomDrawCellBaseThreadSafeEventArgsProvides thread-safe access to data for custom painting events invoked for particular data cells.
PivotCustomDrawCellEventArgsProvides data for the PivotGridControl.CustomDrawCell event.
PivotCustomDrawCellThreadSafeEventArgsProvides thread-safe access to the PivotGridControl.CustomDrawCell event data.
PivotCustomDrawEventArgsProvides data for the PivotGridControl.CustomDrawEmptyArea event.
PivotCustomDrawFieldHeaderEventArgsProvides data for the PivotGridControl.CustomDrawFieldHeader event.
PivotCustomDrawFieldHeaderThreadSafeEventArgsProvides thread-safe access to the PivotGridControl.CustomDrawFieldHeader event data.
PivotCustomDrawFieldValueEventArgsProvides data for the PivotGridControl.CustomDrawFieldValue event.
PivotCustomDrawFieldValueThreadSafeEventArgsProvides thread-safe access to the PivotGridControl.CustomDrawFieldValue event data.
PivotCustomDrawHeaderAreaEventArgsProvides data for the PivotGridControl.CustomDrawFieldHeaderArea event.
PivotCustomDrawHeaderAreaThreadSafeEventArgsProvides thread-safe access to the PivotGridControl.CustomDrawFieldHeaderArea event data.
PivotCustomDrawThreadSafeEventArgsProvides thread-safe access to the PivotGridControl.CustomDrawEmptyArea event data.
PivotCustomFieldValueCellsEventArgsProvides data for the PivotGridControl.CustomFieldValueCells event.
PivotCustomFilterPopupItemsEventArgsProvides data for the PivotGridControl.CustomFilterPopupItems event.
PivotCustomGroupIntervalEventArgsProvides data for the PivotGridControl.CustomGroupInterval event.
PivotCustomRowHeightEventArgsProvides data for the PivotGridControl.CustomRowHeight event.
PivotFieldDisplayTextEventArgsProvides data for the PivotGridControl.FieldValueDisplayText event.
PivotFieldEventArgsProvides data for all field handling events.
PivotFieldFilterChangingEventArgsProvides data for the PivotGridControl.FieldFilterChanging event.
PivotFieldImageIndexEventArgsProvides data for the PivotGridControl.FieldValueImageIndex event.
PivotFieldImageIndexThreadSafeEventArgsProvides thread-safe access to the PivotGridControl.FieldValueImageIndex event data.
PivotFieldPropertyChangedEventArgsProvides data for the PivotGridControl.FieldPropertyChanged event.
PivotFieldTooltipShowingEventArgsProvides data for the PivotGridControl.FieldTooltipShowing event.
PivotFieldValueCancelEventArgsProvides data for the PivotGridControl.FieldValueCollapsing and PivotGridControl.FieldValueExpanding events.
PivotFieldValueEventArgsServes as a base for the classes that provide data for the events which are used to customize column and row headers.
PivotFieldValueHitInfoContains information on the field value located under the test point.
PivotFilterA filter applied to data displayed in the PivotGridControl.
PivotGridAppearancesProvides the appearance settings used to paint a PivotGridControl.
PivotGridAppearancesBaseRepresents the base class for classes that provide appearance settings for a PivotGridControl.
PivotGridAppearancesPrintProvides the appearance settings used to paint the elements in a Pivot Grid Control when it’s printed.
PivotGridCellsStores information on the cells displayed within the PivotGrid control.
PivotGridControlAllows you to create a pivot table (cross-tabular format) for multi-dimensional analysis of large amounts of data.
PivotGridCustomFieldSortEventArgsProvides data for the PivotGridControl.CustomFieldSort event.
PivotGridCustomSummaryEventArgsProvides data for the PivotGridControl.CustomSummary event.
PivotGridCustomTotalRepresents a custom total which can be calculated for an outer column field or row field.
PivotGridCustomTotalCollectionRepresents a collection of custom totals for a field.
PivotGridFieldA field within the PivotGridControl.
PivotGridFieldAppearancesProvides the appearance settings used to paint the elements in a field.
PivotGridFieldCollectionA collection of PivotGrid control fields.
PivotGridFieldImageOptionsContains settings that allow you to set up raster and vector icons for the current PivotGridField.
PivotGridFieldOptionsExContains options for a field.
PivotGridFieldOptionsFilterContains the field’s filtering options.
PivotGridFieldToolTipsProvides tooltip options for a Pivot Grid field.
PivotGridFormatConditionCollectionA collection of style format conditions.
PivotGridFormatRuleA format rule used to apply conditional formatting to Pivot Grid Control data cells.
PivotGridFormatRuleCollectionA collection of PivotGridFormatRule objects.
PivotGridHeadersAreaHitInfoContains information about a specific point within a Header Area.
PivotGridHitInfoContains information about a specific point within a PivotGridControl.
PivotGridMenu
PivotGridMenuEventArgsObsolete. Provides data for the DevExpress.XtraPivotGrid.PivotGridControl.ShowMenu event.
PivotGridMenuEventArgsBaseThe base class for classes providing data for the PivotGrid control’s menu handling events.
PivotGridMenuItemClickEventArgsProvides data for the PivotGridControl.MenuItemClick event.
PivotGridMenuItemClickEventArgsBaseThe base class for classes that provide data for the PivotGrid control’s menu item clicking events.
PivotGridOptionsBehaviorProvides behavior options for the control.
PivotGridOptionsCustomizationExProvides customization options for a PivotGrid control.
PivotGridOptionsFilterContains Pivot Grid’s filter options.
PivotGridOptionsFilterPopupContains options that affect the appearance and behavior of filter dropdown windows.
PivotGridOptionsHintProvides hint options for a PivotGrid control.
PivotGridOptionsMenuProvides the context menu options for the control.
PivotGridOptionsViewProvides view options for the PivotGrid controls.
PivotGridStyleFormatConditionA single style format condition.
PivotGroupEventArgsProvides data for the PivotGridControl.GroupFilterChanged event.
PivotLeftTopCellChangedEventArgsProvides data for the PivotGridControl.LeftTopCellChanged event.
PivotOlapExceptionEventArgsProvides data for the PivotGridControl.OLAPException event.
PivotOlapQueryDataEventArgsProvides data for the PivotGridControl.OLAPQueryData event.
PivotQueryExceptionEventArgsProvides data for the PivotGridControl.QueryException event.
PivotUserActionEventArgsProvides data for the PivotGridControl.UserActionChanged event.
PivotXlsExportOptionsContains Pivot Grid options that define how a document is exported to XLS format in the data-aware export mode.
PivotXlsxExportOptionsContains Pivot Grid options that define how a document is exported to XLSX format in the data-aware export mode.
PopupMenuShowingEventArgsProvides data for the PivotGridControl.PopupMenuShowing event.
RankBindingDefines the calculation of a ranking in the window.
RunningTotalBindingDefines the calculation that aggregates values cumulatively in the window.
WindowExpressionBindingDefines the calculation that uses a custom string expression with window functions.

Delegates

NameDescription
CustomEditValueEventHandlerRepresents a method that will handle the PivotGridControl.CustomEditValue event.
CustomFieldDataEventHandlerRepresents a method that will handle the PivotGridControl.CustomUnboundFieldData event.
CustomizationFormShowingEventHandlerRepresents a method that will handle the PivotGridControl.ShowingCustomizationForm event.
CustomizePivotCellEventHandlerRepresents a method that will handle the PivotXlsxExportOptions.CustomizeCell and PivotXlsxExportOptions.CustomizeCell events.
EditValueChangedEventHandlerRepresents a method that will handle the PivotGridControl.EditValueChanged event.
FilterPopupExcelCustomizeTemplateEventHandlerReferences a method that will handle the ColumnView.FilterPopupExcelCustomizeTemplate event.
FilterPopupExcelDataEventHandlerReferences a method that will handle the PivotGridControl.FilterPopupExcelData event.
FilterPopupExcelEventHandlerReferences a method that will handle the PivotGridControl.ShowFilterPopupExcel event.
FilterPopupExcelPrepareTemplateEventHandlerReferences a method that will handle the PivotGridControl.FilterPopupExcelPrepareTemplate event.
FilterPopupExcelQueryFilterCriteriaEventHandlerReferences a method that will handle the PivotGridControl.FilterPopupExcelCustomizeTemplate event.
PivotAreaChangingEventHandlerRepresents a method that will handle the PivotGridControl.FieldAreaChanging event.
PivotCellDisplayTextEventHandlerRepresents a method that will handle the PivotGridControl.CustomCellDisplayText event.
PivotCellEventHandlerRepresents a method that will handle the PivotGridControl.CellDoubleClick event.
PivotCustomAppearanceEventHandlerRepresents a method that will handle the PivotGridControl.CustomAppearance event.
PivotCustomChartDataSourceDataEventHandlerRepresents a method that will handle the PivotGridControl.CustomChartDataSourceData event.
PivotCustomChartDataSourceRowsEventHandlerReferences a method that will handle the PivotGridControl.CustomChartDataSourceRows event.
PivotCustomDrawCellEventHandlerRepresents a method that will handle the PivotGridControl.CustomDrawCell event.
PivotCustomDrawEventHandlerRepresents a method that will handle the PivotGridControl.CustomDrawEmptyArea event.
PivotCustomDrawFieldHeaderEventHandlerRepresents a method that will handle the PivotGridControl.CustomDrawFieldHeader event.
PivotCustomDrawFieldValueEventHandlerRepresents a method that will handle the PivotGridControl.CustomDrawFieldValue event.
PivotCustomDrawHeaderAreaEventHandlerRepresents a method that will handle the PivotGridControl.CustomDrawFieldHeaderArea event.
PivotCustomFieldValueCellsEventHandlerRepresents a method that will handle the PivotGridControl.CustomFieldValueCells event.
PivotCustomFilterPopupItemsEventHandlerRepresents a method that will handle the PivotGridControl.CustomFilterPopupItems event.
PivotCustomGroupIntervalEventHandlerRepresents a method that will handle the PivotGridControl.CustomGroupInterval event.
PivotFieldDisplayTextEventHandlerRepresents a method that will handle the PivotGridControl.FieldValueDisplayText event.
PivotFieldEventHandlerRepresents a method that will handle the PivotGridControl.FieldFilterChanged, PivotGridControl.FieldAreaChanged and PivotGridControl.FieldWidthChanged events.
PivotFieldFilterChangingEventHandlerRepresents a method that will handle the PivotGridControl.FieldFilterChanging event.
PivotFieldImageIndexEventHandlerRepresents a method that will handle the PivotGridControl.FieldValueImageIndex event.
PivotFieldPropertyChangedEventHandlerRepresents a method that will handle the PivotGridControl.FieldPropertyChanged event.
PivotFieldTooltipShowingEventHandlerRepresents a method that will handle the PivotGridControl.FieldTooltipShowing event.
PivotFieldValueCancelEventHandlerRepresents a method that will handle the PivotGridControl.FieldValueCollapsing and PivotGridControl.FieldValueExpanding events.
PivotFieldValueEventHandlerRepresents a method that will handle the PivotGridControl.FieldValueCollapsed and PivotGridControl.FieldValueExpanded events.
PivotGridCustomFieldSortEventHandlerRepresents a method that will handle the PivotGridControl.CustomFieldSort event.
PivotGridCustomSummaryEventHandlerRepresents a method that will handle the PivotGridControl.CustomSummary event.
PivotGridMenuEventHandlerRepresents a method that will handle the DevExpress.XtraPivotGrid.PivotGridControl.ShowMenu event.
PivotGridMenuItemClickEventHandlerRepresents a method that will handle the PivotGridControl.MenuItemClick event.
PivotGroupEventHandlerRepresents a method that will handle the PivotGridControl.GroupFilterChanged event.
PivotOlapExceptionEventHandlerReferences a method that will handle the PivotGridControl.OLAPException event.
PivotQueryExceptionEventHandlerReferences a method that will handle the PivotGridControl.QueryException event.
PivotUserActionEventHandlerReferences a method that will handle the PivotGridControl.UserActionChanged event.
PopupMenuShowingEventHandlerRepresents a method that will handle the PivotGridControl.PopupMenuShowing event.

Enums

NameDescription
DateTimeGroupIntervalsLists possible DateTime group interval combinations.
ExcelFilterDateTimeValuesTabFilterTypeLists filter control types that can appear in the Values tab of the Excel-style Filter popup (if the current field contains date-time values).
ExcelFilterDefaultTabLists values that specify the default tab in the Excel-style filter popup.
ExcelFilterEnumFiltersLists values that specify a set of relational operators (equality and inequalities) used to create a filter condition in the Filters tab of the Excel-style filter popup (if the current field contains enumeration data).
ExcelFilterNumericValuesTabFilterTypeLists filter control types that can appear in the Values tab of the Excel-style filter popup (if the current field contains numeric data).
ExcelFilterTextFiltersLists values that specify a set of relational operators (equality and inequalities) used to create a filter condition in the Filters tab of the Excel-style filter popup (if the current field contains text data).
FieldFilterPopupModeLists values that specify the field’s filter popup mode.
FilterPopupToolbarButtonsLists values that identify buttons displayed within filter popup toolbars.
PivotContextMenuIdsLists IDs that identify context menu items.
PivotEndUpdateModeLists values that specify whether the Pivot Grid Control is immediately redrawn after calling the PivotGridControl.EndUpdate method.
PivotGridAppearancesBase.PivotCellItemFlags
PivotGridHeaderHitTestLists values that identify the visual elements of a field header.
PivotGridHitTestLists values that identify a Pivot Grid Control’s elements.
PivotGridMenuTypeLists values that specify the Pivot Grid Control’s context menu types.
PivotGridScrollingContains values that specify how the PivotGrid control is scrolled horizontally.
PivotGridValueHitTestLists values that specify which field value cell element is located under the test point.
PivotShowButtonModeEnumContains values that specify which cells of a data field display editor buttons.
UserActionLists values that specify end-user actions on the PivotGridControl.