CustomSummaryEventArgs.TotalValue Property

Gets or sets the total summary value.

Namespace: DevExpress.Data

Assembly: DevExpress.Data.v19.2.dll

Declaration

C#

public object TotalValue { get; set; }

VB.NET

Public Property TotalValue As Object

Property Value

Type	Description
Object	An object representing the total summary value.

Remarks

The TotalValue property represents the total summary value that accumulates the custom calculated value. Note that this property should be initialized before the summary calculation process starts. To identify the status of the custom summary calculation, use the CustomSummaryEventArgs.SummaryProcess property. When performing calculations, you need to refresh the TotalValue property for it to be updated with the new values.

You can also modify the TotalValue property’s value when finalizing the calculation. In this case, the CustomSummaryEventArgs.SummaryProcess property returns the CustomSummaryProcess.Finalize value.

Related GitHub Examples

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

how-to-select-data-rows-e1666/CS/DXGrid_RowSelection/Window1.xaml.cs#L24

if (e.SummaryProcess == DevExpress.Data.CustomSummaryProcess.Start)
    e.TotalValue = 0;
if (e.SummaryProcess == DevExpress.Data.CustomSummaryProcess.Calculate)

how-to-calculate-the-total-summary-value-based-on-values-of-other-summaries-e1429/CS/Default.aspx.cs#L19

    Decimal expense = Convert.ToDecimal(((ASPxGridView)sender).GetTotalSummaryValue(expenseSummary));
    e.TotalValue = income - expense;
}

a-better-way-to-implement-a-frequently-used-custom-summary-weighted-averages-example-e892/CS/Form1.cs#L168

if(e.Item == view.Columns["UnitPrice"].SummaryItem) {
    e.TotalValue = CustomSummaryHelper.GetWeightedAverage(view, "Quantity", "UnitPrice");
}

how-to-add-a-custom-summary-item-to-the-grids-footer-menu-e496/CS/Form1.cs#L85

    if (e.SummaryProcess == DevExpress.Data.CustomSummaryProcess.Finalize)
        e.TotalValue = validRowCount;
}

how-to-display-a-group-row-value-in-a-group-footer-summary-cell-e307/CS/WindowsApplication8/Form1.cs#L28

if (e.SummaryProcess == DevExpress.Data.CustomSummaryProcess.Finalize && ((GridGroupSummaryItem)e.Item).Tag.Equals(1)) {
    e.TotalValue = (sender as GridView).GetGroupRowValue(e.RowHandle);
}

VB.NET

how-to-select-data-rows-e1666/VB/DXGrid_RowSelection/Window1.xaml.vb#L27

If e.SummaryProcess = DevExpress.Data.CustomSummaryProcess.Start Then
    e.TotalValue = 0
End If

how-to-calculate-the-total-summary-value-based-on-values-of-other-summaries-e1429/VB/Default.aspx.vb#L22

    Dim expense As Decimal = Convert.ToDecimal((CType(sender, ASPxGridView)).GetTotalSummaryValue(expenseSummary))
    e.TotalValue = income - expense
End Sub

a-better-way-to-implement-a-frequently-used-custom-summary-weighted-averages-example-e892/VB/Form1.vb#L163

If e.Item Is view.Columns("UnitPrice").SummaryItem Then
    e.TotalValue = CustomSummaryHelper.GetWeightedAverage(view, "Quantity", "UnitPrice")
End If

how-to-add-a-custom-summary-item-to-the-grids-footer-menu-e496/VB/Form1.vb#L85

If e.SummaryProcess = DevExpress.Data.CustomSummaryProcess.Finalize Then
    e.TotalValue = validRowCount
End If

how-to-display-a-group-row-value-in-a-group-footer-summary-cell-e307/VB/WindowsApplication8/Form1.vb#L25

If e.SummaryProcess = DevExpress.Data.CustomSummaryProcess.Finalize AndAlso CType(e.Item, GridGroupSummaryItem).Tag.Equals(1) Then
    e.TotalValue = (TryCast(sender, GridView)).GetGroupRowValue(e.RowHandle)
End If