PivotGridCustomSummaryEventArgs Class

Provides data for the PivotGridControl.CustomSummary event.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.XtraPivotGrid.v18.1.dll

Declaration

C#

public class PivotGridCustomSummaryEventArgs :
    PivotGridCustomSummaryEventArgsBase<PivotGridField>

VB.NET

Public Class PivotGridCustomSummaryEventArgs
    Inherits PivotGridCustomSummaryEventArgsBase(Of PivotGridField)

Related API Members

PivotGridCustomSummaryEventArgs is the data class for the following events:

• PivotGridControl.CustomSummary

Remarks

The PivotGridControl.CustomSummary event allows summaries in cells to be calculated manually. See the PivotGridControl.CustomSummary topic for more details.

Note

The PivotCellEventArgsBase<TField, TData, TCustomTotal>.SummaryValue property returns the same PivotSummaryValue object for all data fields bound to the same field in a data source.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the PivotGridCustomSummaryEventArgs 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.

C#

how-to-display-the-difference-of-income-and-outlay-in-totals-t413352/CS/WindowsApplication53/Form1.cs#L40

private void pivotGridControl1_CustomSummary(object sender, PivotGridCustomSummaryEventArgs e)
{

how-to-calculate-a-cell-summary-value-based-upon-another-field-value-e2392/CS/WindowsApplication53/Form1.cs#L42

private void pivotGridControl1_CustomSummary(object sender, DevExpress.XtraPivotGrid.PivotGridCustomSummaryEventArgs e)
{

how-to-implement-a-custom-sort-by-summary-feature-e2917/CS/WindowsApplication53/Form1.cs#L51

private void pivotGridControl1_CustomSummary(object sender, DevExpress.XtraPivotGrid.PivotGridCustomSummaryEventArgs e) {
    e.CustomValue = e.CreateDrillDownDataSource().RowCount;

how-to-implement-the-distinct-count-summary-type-within-the-pivotgrid-e637/CS/CustomSummaryDistinctCountExample/Form1.cs#L30

private void PivotGridControl1_CustomSummary(object sender, PivotGridCustomSummaryEventArgs e)
{

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

private void pivotGridControl1_CustomSummary(object sender, PivotGridCustomSummaryEventArgs e) {
    if (ReferenceEquals(e.DataField, fieldProductAmount1)) {

VB.NET

how-to-display-the-difference-of-income-and-outlay-in-totals-t413352/VB/WindowsApplication53/Form1.vb#L38

Private Sub pivotGridControl1_CustomSummary(ByVal sender As Object,
                            ByVal e As PivotGridCustomSummaryEventArgs) Handles pivotGridControl1.CustomSummary
    If e.DataField.Name = "fieldValue" Then

how-to-calculate-a-cell-summary-value-based-upon-another-field-value-e2392/VB/WindowsApplication53/Form1.vb#L39

Private Sub pivotGridControl1_CustomSummary(ByVal sender As Object, ByVal e As DevExpress.XtraPivotGrid.PivotGridCustomSummaryEventArgs) Handles pivotGridControl1.CustomSummary
    If e.DataField.Name = "fieldValue" Then

how-to-implement-a-custom-sort-by-summary-feature-e2917/VB/WindowsApplication53/Form1.vb#L53

Private Sub pivotGridControl1_CustomSummary(ByVal sender As Object, ByVal e As DevExpress.XtraPivotGrid.PivotGridCustomSummaryEventArgs) Handles pivotGridControl1.CustomSummary
    e.CustomValue = e.CreateDrillDownDataSource().RowCount

how-to-implement-the-distinct-count-summary-type-within-the-pivotgrid-e637/VB/CustomSummaryDistinctCountExample/Form1.vb#L28

        Private Sub PivotGridControl1_CustomSummary(ByVal sender As Object, ByVal e As PivotGridCustomSummaryEventArgs)
'INSTANT VB NOTE: The variable name was renamed since Visual Basic does not handle local variables named the same as class members well:

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

Private Sub pivotGridControl1_CustomSummary(ByVal sender As Object,
            ByVal e As PivotGridCustomSummaryEventArgs) Handles PivotGridControl1.CustomSummary
    If ReferenceEquals(e.DataField, fieldProductAmount1) Then

Inheritance

Object

EventArgs

PivotGridCustomSummaryEventArgsBase<PivotGridField>

PivotGridCustomSummaryEventArgs