PivotGridFieldBase.SummaryType Property

Gets or sets the type of the summary function which is calculated against the current data field.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.PivotGrid.v20.2.Core.dll

NuGet Packages: DevExpress.PivotGrid.Core, DevExpress.WindowsDesktop.PivotGrid.Core

Declaration

C#

[DefaultValue(PivotSummaryType.Sum)]
public PivotSummaryType SummaryType { get; set; }

VB.NET

<DefaultValue(PivotSummaryType.Sum)>
Public Property SummaryType As PivotSummaryType

Property Value

Type	Default	Description
PivotSummaryType	**Sum**	A PivotSummaryType enumeration value that specifies the summary function type which is calculated against the current field.

Available values:

Show 13 items

Name	Description
Count	The number of values (excluding Null and DBNull values).
Sum	The sum of the values.
Min	The smallest value.
Max	The largest value.
Average	The average of the values.
StdDev	An estimate of the standard deviation of a population, where the sample is a subset of the entire population.
StdDevp	The standard deviation of a population, where the population is all of the data to be summarized.
Var	An estimate of the variance of a population, where the sample is a subset of the entire population.
Varp	The variance of a population, where the population is all of the data to be summarized.
Custom	Specifies whether calculations should be performed manually, by handling the CustomSummary event. Not supported in OLAP and server mode.
CountDistinct	The number of distinct values. This function works only in the Optimized mode.
Median	The median of the values. A median is the number separating the higher half of a value range from the lower half. This function works only in the Optimized mode.
Mode	The mode of the values. A mode is the value that is repeated more often than any other. This function works only in the Optimized mode.

Remarks

PivotGridControl calculates summaries against data fields. The summary function type is determined by the field’s SummaryType property.

For fields which don’t contain numeric data only the following summary functions can be calculated: PivotSummaryType.Count, PivotSummaryType.Min and PivotSummaryType.Max. If the field’s SummaryType property is set to any other value the corresponding data cells will display zeros.

For numeric data fields any summary function type listed by the PivotSummaryType enumerator can be calculated.

Note

The SummaryType property is not in effect in the OLAP mode. The summary type of a measure is controlled by Analysis Services itself and it is not possible to customize it using the PivotGrid control.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the SummaryType property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

winforms-pivotgrid--display-the-difference-of-income-and-outlay-in-totals/CS/PivotGridCustomSummaryExample/Form1.cs#L47

{
    pivotGridControl1.Fields["Value"].SummaryType = DevExpress.Data.PivotGrid.PivotSummaryType.Custom;
    pivotGridControl1.CustomSummary += pivotGridControl1_CustomSummary;

winforms-pivot-grid-implement-the-distinct-count-summary-type/CS/CustomSummaryDistinctCountExample/Form1.cs#L34

if (e.DataField.SummaryType == DevExpress.Data.PivotGrid.PivotSummaryType.Custom)
{

XAF_how-to-make-pivotgridcontrol-editable-when-using-the-pivot-chart-analysis-module-e1232/CS/WinSample.Module.Win/PivotGridInplaceEditorsController.cs#L68

((PivotGridField)field).FieldEdit = new RepositoryItemCheckEdit();
field.SummaryType = DevExpress.Data.PivotGrid.PivotSummaryType.Min;
field.Area = PivotArea.DataArea;

how-to-provide-custom-summary-values-for-total-grand-total-and-ordinary-cells-t555679/CS/WinPivotCustomSummaryCellType/Form1.cs#L12

    customerReportsTableAdapter1.Fill(nwindDataSet1.CustomerReports);
    fieldProductAmount1.SummaryType = DevExpress.Data.PivotGrid.PivotSummaryType.Custom;
}

VB.NET

winforms-pivotgrid--display-the-difference-of-income-and-outlay-in-totals/VB/PivotGridCustomSummaryExample/Form1.vb#L38

Private Sub UseLegacyApproach()
    pivotGridControl1.Fields("Value").SummaryType = DevExpress.Data.PivotGrid.PivotSummaryType.Custom
    AddHandler pivotGridControl1.CustomSummary, AddressOf pivotGridControl1_CustomSummary

winforms-pivot-grid-implement-the-distinct-count-summary-type/VB/CustomSummaryDistinctCountExample/Form1.vb#L32

If e.DataField.SummaryType = DevExpress.Data.PivotGrid.PivotSummaryType.Custom Then
    Dim list As IList = e.CreateDrillDownDataSource()

XAF_how-to-make-pivotgridcontrol-editable-when-using-the-pivot-chart-analysis-module-e1232/VB/WinSample.Module.Win/PivotGridInplaceEditorsController.vb#L71

CType(field, PivotGridField).FieldEdit = New RepositoryItemCheckEdit()
field.SummaryType = DevExpress.Data.PivotGrid.PivotSummaryType.Min
field.Area = PivotArea.DataArea

how-to-provide-custom-summary-values-for-total-grand-total-and-ordinary-cells-t555679/VB/VBWinPivotCustomSummaryCellType/Form1.vb#L10

CustomerReportsTableAdapter1.Fill(NwindDataSet1.CustomerReports)
fieldProductAmount1.SummaryType = PivotSummaryType.Custom

pivot-grid-aggr-examples/VB/Pivot-Aggr-Examples/CodeFiles/CodeExample.vb#L45

salesByYearByCountry.Caption = "Average Sales by Year"
salesByYearByCountry.SummaryType = PivotSummaryType.Average
salesByYearByCountry.CellFormat.FormatType = DevExpress.Utils.FormatType.Custom