Back to Devexpress

DevExpress.Xpf.PivotGrid Namespace

wpf-devexpress-dot-xpf-612b64a5.md

latest39.2 KB
Original Source

DevExpress.Xpf.PivotGrid Namespace

Contains classes which implement the main functionality of the DXPivotGrid Suite. To use these classes in XAML code, add the xmlns:dxpg=”http://schemas.devexpress.com/winfx/2008/xaml/pivotgrid“ namespace reference.

Assembly : DevExpress.Xpf.PivotGrid.v25.2.dll

NuGet Package : DevExpress.Wpf.PivotGrid

Classes

NameDescription
AsyncOperationResultThe result of the asynchronous operation.
CalculationBindingThe base class used to specify a PivotGrid’s field calculation data binding in Optimized mode.
CellElementA Pivot Grid’s data cell to which the cell style is applied.
CellElementDataContains the pivot grid’s cell data, location, and layout characteristics.
CellInfoStores information about the data cell displayed within the PivotGrid control.
ColorScaleFormatConditionRepresents a color scale format condition.
CustomizePivotCellEventArgsContains data for the PivotGridXlsExportOptions.CustomizeCell, PivotGridCsvExportOptions.CustomizeCell and PivotGridXlsxExportOptions.CustomizeCell events.
CustomServerModeSortEventArgsProvides data for the PivotGridControl.CustomServerModeSort event.
DataAreaElementThe base class for the data area cells and field value cells.
DataAreaElementDataContains the field value cell’s and data area cell’s data, location, and layout characteristics.
DataBarFormatConditionRepresents a data bar format condition.
DataBindingBase class of the the Data Binding API. Specifies the source data for the PivotGrid fields in Optimized mode.
DataSourceColumnBindingDefines a data binding to a data source column.
DefaultMenuItemNames staticContains names of the context menu items.
DifferenceBindingDefines the difference calculation between values across a window.
DirectedCalculationBindingBase class to specify calculations whose result is dependent on the direction of the calculation. Used as a PivotGrid’s field calculation data binding in Optimized mode.
EventArgsToCellInfoConverterA converter used to convert the event argument to the CellInfo class.
EventArgsToFieldValueInfoConverterA converter used to convert the event argument to the FieldValueInfo class.
ExpressionConditionBaseServes as a base for classes that represent expression-type format conditions.
ExpressionDataBindingDefines a calculation based on a string expression.
FieldFilterValuesContains filter values for a specific field.
FieldListControlBaseServes as the base class for a pivot grid’s Customization Controls.
FieldValueCellRepresents a field value cell.
FieldValueElementA Pivot Grid field value cell to which the cell style is applied.
FieldValueElementDataContains the pivot grid’s field value cell data, location, and layout characteristics.
FieldValueInfoStores information about the row and column fields related to the selected cell.
FormatConditionRepresents a format condition based on a specified rule(s) or expression.
FormatConditionBaseServes as a base for classes that represent format conditions.
FormatConditionCollectionRepresents a collection of format conditions.
FormatConditionCommandParametersContains parameters for conditional formatting commands.
GroupChangedEventArgsProvides data for the PivotGridGroup.Changed event.
GroupFilterValueA group filter value.
GroupFilterValuesRepresents a group filter condition.
GroupFilterValuesCollectionA collection of group filter values.
IconSetFormatConditionRepresents an icon set format condition.
IndicatorFormatConditionBaseServes as a base for classes that represent indicator-type format conditions.
LightweightCellElement
LightweightFieldValueElement
MovingCalculationBindingDefines aggregations across a specified number of values before and/or after the current value.
OlapExpressionBindingAllows you to use an expression to evaluate values for a Pivot Grid’s field in OLAP mode.
PercentOfTotalBindingAllows you to calculate the input of all values in the window as a percentage of the total.
PivotBrushChangedEventArgsProvides data for the PivotGridControl.BrushChanged event.
PivotCellBaseEventArgsProvides data for the events which are invoked for particular data cells.
PivotCellDisplayTextEventArgsProvides data for the PivotGridControl.CustomCellDisplayText event.
PivotCellEventArgsProvides data for the PivotGridControl.CellClick and PivotGridControl.CellDoubleClick events.
PivotCellValueEventArgsProvides data for the PivotGridControl.CustomCellValue event.
PivotChartDataSourceRowA row in the datasource passed to the chart control.
PivotCustomCellAppearanceEventArgsProvides data for the PivotGridControl.CustomCellAppearance event.
PivotCustomChartDataSourceDataEventArgsProvides data for the PivotGridControl.CustomChartDataSourceData event.
PivotCustomChartDataSourceRowsEventArgsProvides data for the PivotGridControl.CustomChartDataSourceRows event.
PivotCustomFieldDataEventArgsProvides data for the PivotGridControl.CustomUnboundFieldData event.
PivotCustomFieldListSortEventArgsProvides data for the PivotGridControl.CustomFieldListSort event.
PivotCustomFieldSortEventArgsProvides data for the PivotGridControl.CustomFieldSort event.
PivotCustomFieldValueCellsEventArgsProvides data for the PivotGridControl.CustomFieldValueCells event.
PivotCustomFilterPopupItemsEventArgsProvides data for the PivotGridControl.CustomFilterPopupItems event.
PivotCustomGroupIntervalEventArgsProvides data for the PivotGridControl.CustomGroupInterval event.
PivotCustomSummaryEventArgsProvides data for the PivotGridControl.CustomSummary event.
PivotCustomValueAppearanceEventArgsProvides data for the PivotGridControl.CustomValueAppearance event.
PivotDrillDownDataRowRepresents a single row in the data source which provides the data used to calculate summaries for individual cells.
PivotDrillDownDataSourceRepresents a list of the records which are used to calculate summaries for individual cells.
PivotExcelFieldListControlAn Excel-style Field List.
PivotExpressionEditorEventArgsProvides data for the ExpressionEditorCreated event.
PivotFieldAreaChangingEventArgsProvides data for the PivotGridControl.FieldAreaChanging event.
PivotFieldDisplayTextEventArgsProvides data for the PivotGridControl.FieldValueDisplayText event.
PivotFieldEventArgsProvides data for all field handling events.
PivotFieldFilterChangingEventArgsProvides data for the PivotGridControl.FieldFilterChanging event.
PivotFieldListControlA simple-style Field List.
PivotFieldPropertyChangedEventArgsProvides data for the PivotGridControl.FieldPropertyChanged 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.
PivotGridCellMenuInfo
PivotGridCommands staticProvides access to pivot grid commands.
PivotGridControlThe PivotGrid control.
PivotGridCsvExportOptionsContains options that define how a document is exported to CSV.
PivotGridCustomTotalRepresents a custom total.
PivotGridCustomTotalCollectionRepresents a collection of custom totals.
PivotGridFieldRepresents a Pivot Grid field.
PivotGridFieldCollectionRepresents a field collection for the PivotGridControl.
PivotGridFieldValueMenuInfo
PivotGridFilterPopupMenuInfo
PivotGridGroupRepresents an individual group of fields.
PivotGridGroupCollectionRepresents a collection of field groups.
PivotGridHeaderMenuInfoContains information about the field header context menu.
PivotGridHeadersAreaMenuInfo
PivotGridMenuInfoContains information about the context menu.
PivotGridPopupMenuA pop-up menu for the Pivot Grid.
PivotGridXlsExportOptionsContains export options specific to XLS format.
PivotGridXlsxExportOptionsContains export options specific to XLS format.
PivotGroupEventArgsProvides data for the PivotGridControl.GroupFilterChanged event.
PivotLayoutAllowEventArgsProvides data for the PivotGridControl.BeforeLoadLayout event.
PivotLayoutUpgradeEventArgsProvides data for the PivotGridControl.LayoutUpgrade event.
PivotOlapExceptionEventArgsProvides data for the PivotGridControl.OlapException event.
PivotOlapKpiMeasuresContains the names of the OLAP measures that represent values of a particular KPI.
PivotOlapKpiValueRepresents values of a KPI.
PivotOlapMemberAn OLAP member.
PivotPropertyChangedEventArgsProvides data for the PivotGridControl.PropertyChanged event.
PivotQueryExceptionEventArgsProvides data for the PivotGridControl.QueryException event.
PivotSerializationOptionsContains options that control how the PivotGridControl’s layout is saved to and restored from a data store (an XML file or stream).
PivotSummaryDataRowRepresents a summary data source row.
PivotSummaryDataSourceRepresents a summary data source.
PivotUnboundExpressionEditorEventArgsProvides data for the PivotGridControl.UnboundExpressionEditorCreated event.
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.
SortByConditionRepresents a sort condition used to identify the column/row by whose values the other field values will be sorted.
SortByConditionCollectionA collection of sort conditions.
TopBottomRuleFormatConditionRepresents a top/bottom format condition.
WindowExpressionBindingSpecifies a custom string expression with window functions to calculate values. Used as a PivotGrid’s field calculation databinding in Optimized mode.

Interfaces

NameDescription
IThreadSafeFieldWhen implemented, provides a read-only access to basic settings of a field.

Delegates

NameDescription
AsyncCompletedHandlerReferences a method executed after an asynchronous operation is completed.
GroupChangedEventHandlerRepresents a method that will handle the PivotGridGroup.Changed event.
PivotBrushChangedEventHandlerA method that will handle the PivotGridControl.BrushChanged event.
PivotCellDisplayTextEventHandlerRepresents a method that will handle the PivotGridControl.CustomCellDisplayText event.
PivotCellEventHandlerRepresents a method that will handle the PivotGridControl.CellClick and PivotGridControl.CellDoubleClick events.
PivotCellValueEventHandlerRepresents a method that will handle the PivotGridControl.CustomCellValue event.
PivotCustomCellAppearanceEventHandlerA method that will handle the PivotGridControl.CustomCellAppearance event.
PivotCustomChartDataSourceDataEventHandlerRepresents a method that will handle the PivotGridControl.CustomChartDataSourceData event.
PivotCustomChartDataSourceRowsEventHandlerReferences a method that will handle the PivotGridControl.CustomChartDataSourceRows event.
PivotCustomFieldDataEventHandlerRepresents a method that will handle the PivotGridControl.CustomUnboundFieldData event.
PivotCustomFieldSortEventHandlerRepresents a method that will handle the PivotGridControl.CustomFieldSort 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.
PivotCustomSummaryEventHandlerRepresents a method that will handle the PivotGridControl.CustomSummary event.
PivotCustomValueAppearanceEventHandlerA method that will handle the PivotGridControl.CustomValueAppearance event.
PivotExpressionEditorEventHandler
PivotFieldAreaChangingEventHandlerRepresents a method that will handle the PivotGridControl.FieldAreaChanging event.
PivotFieldDisplayTextEventHandlerRepresents a method that will handle the PivotGridControl.FieldValueDisplayText event.
PivotFieldEventHandlerRepresents a method that will handle the PivotGridControl.FieldAreaChanged, PivotGridControl.FieldExpandedInGroupChanged, PivotGridControl.FieldFilterChanged, PivotGridControl.FieldSizeChanged and PivotGridControl.FieldUnboundExpressionChanged events.
PivotFieldFilterChangingEventHandlerRepresents a method that will handle the PivotGridControl.FieldFilterChanging event.
PivotFieldPropertyChangedEventHandlerRepresents a method that will handle the PivotGridControl.FieldPropertyChanged event.
PivotFieldValueCancelEventHandlerRepresents a method that will handle the PivotGridControl.FieldValueCollapsing and PivotGridControl.FieldValueExpanding events.
PivotFieldValueEventHandlerRepresents a method that will handle the PivotGridControl.FieldValueCollapsed, PivotGridControl.FieldValueExpanded and PivotGridControl.FieldValueNotExpanded events.
PivotGroupEventHandlerRepresents a method that will handle the PivotGridControl.GroupFilterChanged event.
PivotLayoutAllowEventHandlerReferences a method that will handle the PivotGridControl.BeforeLoadLayout event.
PivotLayoutUpgradeEventHandlerRepresents a method that will handle the PivotGridControl.LayoutUpgrade event.
PivotOlapExceptionEventHandlerReferences a method that will handle the PivotGridControl.OlapException event.
PivotPropertyChangedEventHandlerRepresents a method that will handle the PivotGridControl.PropertyChanged event.
PivotQueryExceptionEventHandlerReferences a method that will handle the PivotGridControl.QueryException event.
PivotUnboundExpressionEditorEventHandler
PopupMenuShowingEventHandlerReferences a method that will handle the PivotGridControl.PopupMenuShowing event.

Enums

NameDescription
AllowHideFieldsTypeLists values that specify when fields can be hidden by end-users.
CalculationDirectionLists possible calculation directions in a table.
CalculationPartitioningCriteriaLists values used to specify a partition (frame) in a data table for window calculations.
CopyCollapsedValuesModeLists values that specify how to copy collapsed field values to the clipboard.
CopyMultiSelectionModeLists values that specify how to copy cells to the clipboard when multiple cells are selected.
DataFieldAreaLists values that specify the area in which the data field headers are displayed.
DataHeadersDisplayMode
DataProcessingEngineLists values that specify an engine used to perform data processing (aggregation, summarization, etc.) in the pivot grid.
DateTimeGroupIntervalsLists possible DateTime group interval combinations.
DifferenceTarget
DifferenceTypeLists the types of differences.
FieldAllowedAreasLists values that specify pivot grid areas where a field can be positioned.
FieldAreaLists the values that specify the areas where the pivot grid fields can be displayed.
FieldBestFitAreaLists the values used to specify which interface elements should be taken into account when calculating the optimal width for columns or rows.
FieldColumnTotalsLocationLists values that specify the location of column totals.
FieldFilterTypeContains the values that specify a field’s filter type in the PivotGrid control.
FieldGroupIntervalContains values that specify how the values of a specific column or row field are combined into groups.
FieldListAllowedLayoutsLists values that specify which layouts can be applied to the Field List.
FieldListAreaLists values that specify which fields the Customization Control should display.
FieldListLayoutLists values that specify the layout of the Field List.
FieldListOrientationLists values that specify how field headers should be arranged within the Customization Control.
FieldListStyleLists values that specify the Field List‘s style.
FieldOLAPFilterUsingWhereClauseLists values that specify whether to use the WHERE clause in an MDX query, when filtering against filter fields in OLAP mode.
FieldPropertyNameLists values that identify properties of fields.
FieldRowTotalsLocationLists values that specify the location of row totals.
FieldSortBySummaryOrderLists values that specify the sort order applied to a field when sorting by summaries is enabled for it.
FieldSortLocationLists values that specify a target UI element whose items are sorted.
FieldSortModeLists the values that specify how a field’s data should be sorted.
FieldSortOrderLists the values that specify the sort order of a pivot grid’s fields.
FieldSummaryDisplayTypeContains options that specify how summary values are displayed within cells (“as is” or adjusted using a specific predefined algorithm).
FieldSummaryTypeLists values that specify the summary function types.
FieldTopValueModeLists values that specify how the top n values for a specified data field are calculated.
FieldTopValueTypeLists the values that specify how the number of Top Values is determined.
FieldTotalsVisibilityContains values that specify which summary totals are displayed for a specific column field or row field.
FieldUnboundColumnTypeContains values that specify the data type and binding mode of columns.
FieldUnboundExpressionModeLists values that specify how the unbound expressions for a specified data field are calculated.
FieldValueTypeLists values that specify the types of column and row field values.
FilterPopupModeLists styles of the filter drop-down to use for the current field.
GroupChangeTypeLists values that specify what caused the field group to change.
GroupFilterModeLists values that specify the filtering mode for grouped fields.
OlapDataProviderLists values that specify which data provider should be used when binding to an OLAP cube.
PivotBrushTypeLists values that identify a brush type.
PivotChartDataProvideModeLists values that specify which data the pivot grid should pass to a bound chart control.
PivotChartDataProvidePriorityLists values that specify whether the pivot grid should pass columns or rows to a bound chart control when it is impossible to find the lowest-level data.
PivotChartExportFieldValueModeLists values that specify how the PivotGridControl’s field values are exported to the chart control.
PivotChartFieldValuesProvideModeLists values that specify how the PivotGridControl’s field values are exported to the chart control.
PivotChartItemDataMemberLists values that specify the type of a chart data member.
PivotChartItemTypeLists values that specify the type of a PivotGridControl’s item to be represented in a ChartControl.
PivotDefaultMemberFieldsLists values that specify for which fields the pivot grid processes only data related to their default members.
PivotGridMenuTypeLists values that specify the pivot grid’s context menu types.
PivotKpiGraphicLists values that specify the graphic set used to indicate KPI values.
PivotKpiTypeLists KPI types.
RankTypeLists rank types.
ScrollingModeLists values specifying the PivotGridControl scrolling mode.
SelectModeLists values that specify the selection mode.
ShowFilterPanelModeLists values that specify when the PivotGridControl displays the Filter Panel.
StoreLayoutModeLists options that specify which settings should be saved when saving the PivotGrid’s layout.
SummaryDataSourceFieldNaming
SummaryFilterModeLists options that specify the aggregation level for summary filtering.
UnboundExpressionModeLists values that specify how the unbound expressions for data fields are calculated.
UseLightweightTemplatesLists values that specify whether to enable the lightweight templates feature.
UserActionLists values that specify end-user actions on the PivotGridControl.