PivotGridCustomTotal Class
Represents a custom total.
Namespace: DevExpress.Xpf.PivotGrid
Assembly: DevExpress.Xpf.PivotGrid.v19.1.dll
Declaration
Related API Members
The following members return PivotGridCustomTotal objects:
Remarks
Custom totals are stored within a field’s PivotGridField.CustomTotals collection. To display custom totals for a column or row field, do the following:
- Set the field’s PivotGridField.TotalsVisibility property to FieldTotalsVisibility.CustomTotals;
- Create the required PivotGridCustomTotal objects, and add them to the PivotGridField.CustomTotals collection.
Custom totals (like automatic totals) are calculated for field values which have nested field values. They are not calculated for the values of the innermost column and row fields. If a field is not a column field or row field, custom totals are not calculated for it.
To learn more, see Totals.
Example
The following example demonstrates how to add custom totals for a particular pivot grid field.
In this example, four different totals are added for the Category Name row field: Average, Sum, Min and Max. For this, they should be added to the PivotGridField.CustomTotals property and the PivotGridField.TotalsVisibility property should be set to FieldTotalsVisibility.CustomTotals.
Note
A complete sample project is available at https://github.com/DevExpress-Examples/how-to-add-custom-totals-e2135.
<Window x:Class="HowToBindToMDB.MainWindow"
xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
xmlns:dxpg="http://schemas.devexpress.com/winfx/2008/xaml/pivotgrid"
Title="MainWindow" Height="350" Width="525" Loaded="Window_Loaded">
<Grid>
<dxpg:PivotGridControl HorizontalAlignment="Left" Name="pivotGridControl1"
VerticalAlignment="Top" RowTotalsLocation="Far">
<dxpg:PivotGridControl.Fields>
<dxpg:PivotGridField Name="fieldCategoryName" FieldName="CategoryName"
Area="RowArea" Caption="Category"
TotalsVisibility="CustomTotals">
<dxpg:PivotGridField.CustomTotals>
<dxpg:PivotGridCustomTotal SummaryType="Average" />
<dxpg:PivotGridCustomTotal SummaryType="Sum" />
<dxpg:PivotGridCustomTotal SummaryType="Max" />
<dxpg:PivotGridCustomTotal SummaryType="Min" />
</dxpg:PivotGridField.CustomTotals>
</dxpg:PivotGridField>
<dxpg:PivotGridField Name="fieldProductName" FieldName="ProductName" Area="RowArea"
Caption="Product Name" />
<dxpg:PivotGridField Name="fieldOrderYear" FieldName="OrderDate" Area="ColumnArea"
Caption="Order Year" GroupInterval="DateYear" />
<dxpg:PivotGridField Name="fieldExtendedPrice" FieldName="Extended Price"
Area="DataArea" CellFormat="c0" />
</dxpg:PivotGridControl.Fields>
</dxpg:PivotGridControl>
</Grid>
</Window>
Related GitHub Examples
The following code snippet (auto-collected from DevExpress Examples) contains a reference to the PivotGridCustomTotal class.
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.