Custom Aggregate Functions

• Dec 17, 2020

The ASPxTreeList enables you to manually implement custom aggregate functions or calculate summary values using a custom algorithm. Custom summaries allow you the following:

• Calculate summaries against nodes that meet specific criteria;
• Involve multiple data fields in calculations;
• Implement complex summary functions.

To manually calculate summaries, you should set the summary item’s TreeListSummaryItem.SummaryType property to ‘Custom’ and handle the ASPxTreeList.CustomSummaryCalculate event.

Example

This example shows how to implement a custom summary calculation.

Create a summary item within the ASPxTreeList.Summary collection and customize its settings as shown below:

The ASPxTreeList.CustomSummaryCalculate event is handled to sum the budgets of selected departments. Finally, set the TreeListSettingsBehavior.ProcessSelectionChangedOnServer option to true.

The image below shows the result:

C#

using DevExpress.Data;

protected void ASPxTreeList2_CustomSummaryCalculate(object sender,
TreeListCustomSummaryEventArgs e) {
    switch (e.SummaryProcess) {
        case CustomSummaryProcess.Start:
            e.Value = (int)0;
            break;
        case CustomSummaryProcess.Calculate:
            if (e.Node.Selected)
                e.Value = (int)e.Value + (int)e.Node["Budget"];
            break;
        case CustomSummaryProcess.Finalize:
            break;
    }
}

VB.NET

Imports DevExpress.Data

Protected Sub ASPxTreeList2_CustomSummaryCalculate(ByVal sender As Object,_
ByVal e As TreeListCustomSummaryEventArgs)
   Select Case e.SummaryProcess
      Case CustomSummaryProcess.Start
         e.Value = CInt(Fix(0))
      Case CustomSummaryProcess.Calculate
         If e.Node.Selected Then
            e.Value = CInt(Fix(e.Value)) + CInt(Fix(e.Node("Budget")))
         End If
      Case CustomSummaryProcess.Finalize
   End Select
End Sub