[Expand]General Information
[Expand]WinForms Controls
[Expand]ASP.NET Controls and MVC Extensions
[Expand]ASP.NET Bootstrap Controls
[Expand]ASP.NET Core Bootstrap Controls
[Collapse]WPF Controls
  Prerequisites
 [Expand]What's Installed
 [Expand].NET Core 3 Support
 [Expand]Common Concepts
 [Expand]MVVM Framework
 [Expand]Controls and Libraries
 [Expand]Scaffolding Wizard
 [Expand]Localization
  Redistribution and Deployment
  Get More Help
 [Collapse]API Reference
  [Expand]DevExpress.Charts.Designer
  [Expand]DevExpress.Data
  [Expand]DevExpress.Mvvm.UI
  [Expand]DevExpress.Mvvm.UI.Interactivity
  [Expand]DevExpress.Mvvm.UI.ModuleInjection
  [Expand]DevExpress.Xpf.Accordion
  [Expand]DevExpress.Xpf.Bars
  [Expand]DevExpress.Xpf.Carousel
  [Expand]DevExpress.Xpf.Charts
  [Expand]DevExpress.Xpf.Charts.Localization
  [Expand]DevExpress.Xpf.Charts.RangeControlClient
  [Expand]DevExpress.Xpf.ChunkList
  [Expand]DevExpress.Xpf.Controls
  [Expand]DevExpress.Xpf.Core
  [Expand]DevExpress.Xpf.Core.ConditionalFormatting
  [Expand]DevExpress.Xpf.Core.DataSources
  [Expand]DevExpress.Xpf.Core.FilteringUI
  [Expand]DevExpress.Xpf.Core.Native
  [Expand]DevExpress.Xpf.Core.ServerMode
  [Expand]DevExpress.Xpf.Data
  [Expand]DevExpress.Xpf.DataAccess
  [Expand]DevExpress.Xpf.DataAccess.DataSourceWizard
  [Expand]DevExpress.Xpf.Diagram
  [Expand]DevExpress.Xpf.Dialogs
  [Expand]DevExpress.Xpf.Docking
  [Expand]DevExpress.Xpf.Docking.Base
  [Expand]DevExpress.Xpf.DocumentViewer
  [Expand]DevExpress.Xpf.DXBinding
  [Expand]DevExpress.Xpf.Editors
  [Expand]DevExpress.Xpf.Editors.DataPager
  [Expand]DevExpress.Xpf.Editors.DateNavigator
  [Expand]DevExpress.Xpf.Editors.ExpressionEditor
  [Expand]DevExpress.Xpf.Editors.ExpressionEditor.Native
  [Expand]DevExpress.Xpf.Editors.Filtering
  [Expand]DevExpress.Xpf.Editors.Flyout
  [Expand]DevExpress.Xpf.Editors.Flyout.Native
  [Expand]DevExpress.Xpf.Editors.Helpers
  [Expand]DevExpress.Xpf.Editors.Native
  [Expand]DevExpress.Xpf.Editors.Popups
  [Expand]DevExpress.Xpf.Editors.RangeControl
  [Expand]DevExpress.Xpf.Editors.Settings
  [Expand]DevExpress.Xpf.Editors.Validation
  [Expand]DevExpress.Xpf.ExpressionEditor
  [Expand]DevExpress.Xpf.Gantt
  [Expand]DevExpress.Xpf.Gauges
  [Expand]DevExpress.Xpf.Gauges.Localization
  [Expand]DevExpress.Xpf.Grid
  [Expand]DevExpress.Xpf.Grid.ConditionalFormatting
  [Expand]DevExpress.Xpf.Grid.LookUp
  [Expand]DevExpress.Xpf.Grid.TreeList
  [Expand]DevExpress.Xpf.Layout.Core
  [Expand]DevExpress.Xpf.LayoutControl
  [Expand]DevExpress.Xpf.Map
  [Expand]DevExpress.Xpf.NavBar
  [Expand]DevExpress.Xpf.Navigation
  [Expand]DevExpress.Xpf.PdfViewer
  [Collapse]DevExpress.Xpf.PivotGrid
    AllowHideFieldsType Enumeration
    AsyncCompletedHandler Delegate
   [Expand]AsyncOperationResult Class
   [Expand]CalculationBinding Class
    CalculationDirection Enumeration
    CalculationPartitioningCriteria Enumeration
   [Expand]CellElement Class
   [Expand]CellElementData Class
   [Expand]CellInfo Class
   [Expand]ColorScaleFormatCondition Class
    CopyCollapsedValuesMode Enumeration
    CopyMultiSelectionMode Enumeration
   [Expand]CustomPrefilterDisplayTextEventArgs Class
    CustomPrefilterDisplayTextEventHandler Delegate
   [Expand]CustomServerModeSortEventArgs Class
   [Expand]DataAreaElement Class
   [Expand]DataAreaElementData Class
   [Expand]DataBarFormatCondition Class
   [Expand]DataBinding Class
    DataFieldArea Enumeration
    DataHeadersDisplayMode Enumeration
    DataProcessingEngine Enumeration
   [Expand]DataSourceColumnBinding Class
   [Expand]DefaultMenuItemNames Class
   [Expand]DifferenceBinding Class
    DifferenceTarget Enumeration
    DifferenceType Enumeration
   [Expand]DirectedCalculationBinding Class
   [Expand]EventArgsToCellInfoConverter Class
   [Expand]EventArgsToFieldValueInfoConverter Class
   [Expand]ExpressionConditionBase Class
   [Expand]ExpressionDataBinding Class
    FieldAllowedAreas Enumeration
    FieldArea Enumeration
    FieldBestFitArea Enumeration
    FieldColumnTotalsLocation Enumeration
    FieldFilterType Enumeration
   [Expand]FieldFilterValues Class
    FieldGroupInterval Enumeration
    FieldListAllowedLayouts Enumeration
    FieldListArea Enumeration
   [Expand]FieldListControlBase Class
    FieldListLayout Enumeration
    FieldListOrientation Enumeration
    FieldListStyle Enumeration
    FieldOLAPFilterUsingWhereClause Enumeration
    FieldPropertyName Enumeration
    FieldRowTotalsLocation Enumeration
    FieldSortBySummaryOrder Enumeration
    FieldSortLocation Enumeration
    FieldSortMode Enumeration
    FieldSortOrder Enumeration
    FieldSummaryDisplayType Enumeration
    FieldSummaryType Enumeration
    FieldTopValueMode Enumeration
    FieldTopValueType Enumeration
    FieldTotalsVisibility Enumeration
    FieldUnboundColumnType Enumeration
    FieldUnboundExpressionMode Enumeration
   [Expand]FieldValueCell Class
   [Expand]FieldValueElement Class
   [Expand]FieldValueElementData Class
   [Expand]FieldValueInfo Class
    FieldValueType Enumeration
    FilterPopupMode Enumeration
   [Expand]FormatCondition Class
   [Expand]FormatConditionBase Class
   [Expand]FormatConditionCollection Class
   [Expand]FormatConditionCommandParameters Class
   [Expand]GroupChangedEventArgs Class
    GroupChangedEventHandler Delegate
    GroupChangeType Enumeration
    GroupFilterMode Enumeration
   [Expand]GroupFilterValue Class
   [Expand]GroupFilterValues Class
   [Expand]GroupFilterValuesCollection Class
   [Expand]IconSetFormatCondition Class
   [Expand]IndicatorFormatConditionBase Class
   [Expand]IThreadSafeField Interface
   [Expand]LightweightCellElement Class
   [Expand]LightweightFieldValueElement Class
   [Expand]MovingCalculationBinding Class
    OlapDataProvider Enumeration
   [Expand]PercentOfTotalBinding Class
   [Expand]PivotBrushChangedEventArgs Class
    PivotBrushChangedEventHandler Delegate
    PivotBrushType Enumeration
   [Expand]PivotCellBaseEventArgs Class
   [Expand]PivotCellDisplayTextEventArgs Class
    PivotCellDisplayTextEventHandler Delegate
   [Expand]PivotCellEventArgs Class
    PivotCellEventHandler Delegate
   [Expand]PivotCellValueEventArgs Class
    PivotCellValueEventHandler Delegate
    PivotChartDataProvideMode Enumeration
    PivotChartDataProvidePriority Enumeration
   [Expand]PivotChartDataSourceRow Class
    PivotChartExportFieldValueMode Enumeration
    PivotChartFieldValuesProvideMode Enumeration
    PivotChartItemDataMember Enumeration
    PivotChartItemType Enumeration
   [Expand]PivotCustomCellAppearanceEventArgs Class
    PivotCustomCellAppearanceEventHandler Delegate
   [Expand]PivotCustomChartDataSourceDataEventArgs Class
    PivotCustomChartDataSourceDataEventHandler Delegate
   [Expand]PivotCustomChartDataSourceRowsEventArgs Class
    PivotCustomChartDataSourceRowsEventHandler Delegate
   [Expand]PivotCustomFieldDataEventArgs Class
    PivotCustomFieldDataEventHandler Delegate
   [Expand]PivotCustomFieldListSortEventArgs Class
   [Expand]PivotCustomFieldSortEventArgs Class
    PivotCustomFieldSortEventHandler Delegate
   [Expand]PivotCustomFieldValueCellsEventArgs Class
    PivotCustomFieldValueCellsEventHandler Delegate
   [Expand]PivotCustomFilterPopupItemsEventArgs Class
    PivotCustomFilterPopupItemsEventHandler Delegate
   [Expand]PivotCustomGroupIntervalEventArgs Class
    PivotCustomGroupIntervalEventHandler Delegate
   [Expand]PivotCustomSummaryEventArgs Class
    PivotCustomSummaryEventHandler Delegate
   [Expand]PivotCustomValueAppearanceEventArgs Class
    PivotCustomValueAppearanceEventHandler Delegate
    PivotDefaultMemberFields Enumeration
   [Expand]PivotDrillDownDataRow Class
   [Expand]PivotDrillDownDataSource Class
   [Expand]PivotExcelFieldListControl Class
   [Expand]PivotFieldAreaChangingEventArgs Class
    PivotFieldAreaChangingEventHandler Delegate
   [Expand]PivotFieldDisplayTextEventArgs Class
    PivotFieldDisplayTextEventHandler Delegate
   [Expand]PivotFieldEventArgs Class
    PivotFieldEventHandler Delegate
   [Expand]PivotFieldFilterChangingEventArgs Class
    PivotFieldFilterChangingEventHandler Delegate
   [Expand]PivotFieldListControl Class
   [Expand]PivotFieldPropertyChangedEventArgs Class
    PivotFieldPropertyChangedEventHandler Delegate
   [Expand]PivotFieldValueCancelEventArgs Class
    PivotFieldValueCancelEventHandler Delegate
   [Expand]PivotFieldValueEventArgs Class
    PivotFieldValueEventHandler Delegate
   [Expand]PivotFilterEditorEventArgs Class
    PivotFilterEditorEventHandler Delegate
   [Expand]PivotGridCellMenuInfo Class
   [Expand]PivotGridCommands Class
   [Collapse]PivotGridControl Class
     PivotGridControl Members
     PivotGridControl Constructor
    [Expand]PivotGridControl Properties
    [Collapse]PivotGridControl Events
      AsyncOperationCompleted Event
      AsyncOperationStarting Event
      BeforeLoadLayout Event
      BeginRefresh Event
      BrushChanged Event
      CellClick Event
      CellDoubleClick Event
      CellSelectionChanged Event
      CustomCellAppearance Event
      CustomCellDisplayText Event
      CustomCellValue Event
      CustomChartDataSourceData Event
      CustomChartDataSourceRows Event
      CustomFieldListSort Event
      CustomFieldSort Event
      CustomFieldValueCells Event
      CustomFilterPopupItems Event
      CustomGroupInterval Event
      CustomPrefilterDisplayText Event
      CustomServerModeSort Event
      CustomSummary Event
      CustomUnboundFieldData Event
      CustomValueAppearance Event
      DataSourceChanged Event
      EndRefresh Event
      FieldAreaChanged Event
      FieldAreaChanging Event
      FieldAreaIndexChanged Event
      FieldExpandedInGroupChanged Event
      FieldFilterChanged Event
      FieldFilterChanging Event
      FieldPropertyChanged Event
      FieldSizeChanged Event
      FieldUnboundExpressionChanged Event
      FieldValueCollapsed Event
      FieldValueCollapsing Event
      FieldValueDisplayText Event
      FieldValueExpanded Event
      FieldValueExpanding Event
      FieldValueNotExpanded Event
      FieldVisibleChanged Event
      FieldVisibleChanging Event
      FocusedCellChanged Event
      GridLayout Event
      GroupFilterChanged Event
      HiddenFieldList Event
      LayoutUpgrade Event
      OlapDataLoaded Event
      OlapException Event
      OlapQueryData Event
      OlapQueryTimeout Event
      PopupMenuShowing Event
      PrefilterCriteriaChanged Event
      PrefilterEditorCreated Event
      PrefilterEditorHiding Event
      PropertyChanged Event
      QueryException Event
      ShownFieldList Event
      UnboundExpressionEditorCreated Event
    [Expand]PivotGridControl Methods
   [Expand]PivotGridCsvExportOptions Class
   [Expand]PivotGridCustomTotal Class
   [Expand]PivotGridCustomTotalCollection Class
   [Expand]PivotGridField Class
   [Expand]PivotGridFieldCollection Class
   [Expand]PivotGridFieldValueMenuInfo Class
   [Expand]PivotGridFilterPopupMenuInfo Class
   [Expand]PivotGridGroup Class
   [Expand]PivotGridGroupCollection Class
   [Expand]PivotGridHeaderMenuInfo Class
   [Expand]PivotGridHeadersAreaMenuInfo Class
   [Expand]PivotGridMenuInfo Class
    PivotGridMenuType Enumeration
   [Expand]PivotGridPopupMenu Class
   [Expand]PivotGridXlsExportOptions Class
   [Expand]PivotGridXlsxExportOptions Class
   [Expand]PivotGroupEventArgs Class
    PivotGroupEventHandler Delegate
    PivotKpiGraphic Enumeration
    PivotKpiType Enumeration
   [Expand]PivotLayoutAllowEventArgs Class
    PivotLayoutAllowEventHandler Delegate
   [Expand]PivotLayoutUpgradeEventArgs Class
    PivotLayoutUpgradeEventHandler Delegate
   [Expand]PivotOlapExceptionEventArgs Class
    PivotOlapExceptionEventHandler Delegate
   [Expand]PivotOlapKpiMeasures Class
   [Expand]PivotOlapKpiValue Class
   [Expand]PivotOlapMember Class
   [Expand]PivotPropertyChangedEventArgs Class
    PivotPropertyChangedEventHandler Delegate
   [Expand]PivotQueryExceptionEventArgs Class
    PivotQueryExceptionEventHandler Delegate
   [Expand]PivotSerializationOptions Class
   [Expand]PivotSummaryDataRow Class
   [Expand]PivotSummaryDataSource Class
   [Expand]PivotUnboundExpressionEditorEventArgs Class
    PivotUnboundExpressionEditorEventHandler Delegate
   [Expand]PopupMenuShowingEventArgs Class
    PopupMenuShowingEventHandler Delegate
   [Expand]RankBinding Class
    RankType Enumeration
   [Expand]RunningTotalBinding Class
    ScrollingMode Enumeration
    SelectMode Enumeration
    ShowPrefilterPanelMode Enumeration
   [Expand]SortByCondition Class
   [Expand]SortByConditionCollection Class
    StoreLayoutMode Enumeration
   [Expand]TopBottomRuleFormatCondition Class
    UnboundExpressionMode Enumeration
    UseLightweightTemplates Enumeration
    UserAction Enumeration
   [Expand]WindowExpressionBinding Class
  [Expand]DevExpress.Xpf.PivotGrid.Printing
  [Expand]DevExpress.Xpf.Printing
  [Expand]DevExpress.Xpf.Printing.Parameters
  [Expand]DevExpress.Xpf.Printing.Parameters.Models
  [Expand]DevExpress.Xpf.Printing.PreviewControl
  [Expand]DevExpress.Xpf.Printing.PreviewControl.Bars
  [Expand]DevExpress.Xpf.Prism
  [Expand]DevExpress.Xpf.PropertyGrid
  [Expand]DevExpress.Xpf.Reports.UserDesigner
  [Expand]DevExpress.Xpf.Reports.UserDesigner.Extensions
  [Expand]DevExpress.Xpf.Reports.UserDesigner.Localization
  [Expand]DevExpress.Xpf.Reports.UserDesigner.ReportWizard
  [Expand]DevExpress.Xpf.Reports.UserDesigner.ReportWizard.Pages
  [Expand]DevExpress.Xpf.Ribbon
  [Expand]DevExpress.Xpf.RichEdit
  [Expand]DevExpress.Xpf.RichEdit.Menu
  [Expand]DevExpress.Xpf.Scheduler
  [Expand]DevExpress.Xpf.Scheduler.Drawing
  [Expand]DevExpress.Xpf.Scheduler.Menu
  [Expand]DevExpress.Xpf.Scheduler.Reporting
  [Expand]DevExpress.Xpf.Scheduler.UI
  [Expand]DevExpress.Xpf.Scheduling
  [Expand]DevExpress.Xpf.Scheduling.Common
  [Expand]DevExpress.Xpf.Scheduling.Editors
  [Expand]DevExpress.Xpf.Scheduling.iCalendar
  [Expand]DevExpress.Xpf.Scheduling.Reporting
  [Expand]DevExpress.Xpf.Scheduling.Visual
  [Expand]DevExpress.Xpf.Scheduling.VisualData
  [Expand]DevExpress.Xpf.SpellChecker
  [Expand]DevExpress.Xpf.Spreadsheet
  [Expand]DevExpress.Xpf.Spreadsheet.Menu
  [Expand]DevExpress.Xpf.TreeMap
  [Expand]DevExpress.Xpf.Utils.Themes
  [Expand]DevExpress.Xpf.WindowsUI
  [Expand]DevExpress.Xpf.WindowsUI.Internal
  [Expand]DevExpress.Xpf.WindowsUI.Navigation
  [Expand]DevExpress.XtraRichEdit
  [Expand]DevExpress.XtraRichEdit.Printing
[Expand]Xamarin Controls
[Expand]Windows 10 App Controls
[Expand]Office File API
[Expand]Reporting
[Expand]Report and Dashboard Server
[Expand]Dashboard
[Expand]eXpressApp Framework
[Expand]eXpress Persistent Objects
[Expand]CodeRush
[Expand]CodeRush Classic
[Expand]Cross-Platform Core Libraries
[Expand]Tools and Utilities
 End-User Documentation
View this topic on docs.devexpress.com (Learn more)

PivotGridControl.CustomSummary Event

Allows you to calculate summary values manually.

Namespace:DevExpress.Xpf.PivotGrid
Assembly:DevExpress.Xpf.PivotGrid.v19.2.dll

Expanded Syntax

Expanded Event Data

The event handler receives an argument of type PivotCustomSummaryEventArgs containing data related to this event.

The following PivotCustomSummaryEventArgs properties provide information specific to this event.
Property Description
ColumnField Gets the column field that corresponds to the current cell.
ColumnFieldValue Gets the value of the Column Field which corresponds to the current cell.
CustomValue Gets or sets a custom summary value.
DataField Gets the data field against which the summary is calculated.
FieldName Gets the name of the Data Field against which the summary is calculated.
RowField Gets the row field that corresponds to the current cell.
RowFieldValue Gets the value of the Row Field which corresponds to the current cell.
SummaryValue Gets an object which contains the values of the predefined summaries that are calculated for the current cell.
ThreadSafeColumnField Gets the column field that corresponds to the current cell. Provides read-only access to field settings.
ThreadSafeDataField Gets the data field against which the summary is calculated. Provides read-only access to field settings.
ThreadSafeRowField Gets the row field that corresponds to the current cell.

Expanded Remarks

The CustomSummary event is raised when the PivotGridControl calculates its data for display. The CustomSummary event occurs for each Cell that displays the value of the field whose PivotGridField.SummaryType property is set to FieldSummaryType.Custom.

In the event handler you can use the PivotCustomSummaryEventArgs.CreateDrillDownDataSource method to get a list of the records that is the data summarized in the current cell. You can process the data to calculate a custom summary and assign the result to the PivotCustomSummaryEventArgs.CustomValue property.

The PivotGridControl calculates all the predefined summaries (Average, Min, Max, Sum, etc) for each cell. You can access the calculated values using the PivotCustomSummaryEventArgs.SummaryValue property and use them in custom summary calculations.

The CustomSummary event occurs when the control layout is not ready yet. It means that other cells, columns and rows are not accessible.

Tip

To include other cells in a custom cell value calculation, handle the CustomCellValue event.

Note

The CustomSummary event is not supported in server and OLAP mode.

Expanded Example

This example demonstrates how to count distinct values (the number of orders with equal product quantities) and display the result in the pivot grid.

This example handles the CustomSummary event that occurs when the control calculates a summary for a field whose SummaryType (see DevExpress.XtraPivotGrid.PivotGridFieldBase.SummaryType) is DevExpress.Data.PivotGrid.PivotSummaryType. The event handler calls the DevExpress.XtraPivotGrid.Data.PivotGridCustomSummaryEventArgsBase`1.CreateDrillDownDataSource method to retrieve the underlying data rows for the current cell, counts distinct values and returns the result to the DevExpress.XtraPivotGrid.Data.PivotGridCustomSummaryEventArgsBase`1.CustomValue property.

Note

The complete sample project How to Create a Custom Summary Type to Display the Distinct Value Count is available in the DevExpress Examples repository.

Expanded See Also

Is this topic helpful?​​​​​​​