Create a Custom Summary

Please note that this control has been retired and is now obsolete to the XamDataGrid control, and as such, we recommend migrating to that control. It will not be receiving any new features, bug fixes, or support going forward. For help or questions on migrating your codebase to the XamDataGrid, please contact support.

Before You Begin

The summary feature comes with a default set of summaries such as Count and Sum. However, in some situations, you may want to expand this default set and add your own custom summaries. This topic will demonstrate how to achieve this.

This topic assumes that you already have the xamGrid™ control bound to data with summaries enabled. For more information on this, see the Data Binding and Summaries topics.

What You Will Accomplish

You will create a custom summary that calculates the standard deviation.

Follow these Steps

Create your own custom class that derives from the SynchronousSummaryCalculator class and name it StandardDeviationCalc.

In Visual Basic:

Public Class StandardDeviationCalc
Inherits SynchronousSummaryCalculator
Public Overrides ReadOnly Property SummaryExecution As SummaryExecution
   Get
      Return Infragistics.SummaryExecution.PriorToFilteringAndPaging
   End Get
End Property
Public Overrides Function Summarize(ByVal data As IQueryable, ByVal fieldKey As String) As Object
   Dim convertedData As ObservableCollection(Of Product) = DataUtil.Products
   ' Variables used for intermediate calculations
   Dim sum As Double = 0
   Dim count As Integer = 0
   Dim squaredsum As Double = 0
   Dim tempVal As Double = 0
   For Each item As Product In convertedData
      ' Value in UnitsInStock column
      tempVal = Convert.ToDouble(item.UnitsInStock)
      count = (count + 1)
      ' Sum values in UnitsInStock column
      sum = (sum + tempVal)
      ' Square values in UnitsInStock column
      squaredsum = (squaredsum _
      + (tempVal * tempVal))
    Next
     If ((count < 2) _
     OrElse (sum = 0)) Then
     Return 0
   End If
   ' Calculate average of UnitsInStock column
   Dim theAverage As Double = (sum / count)
   ' StandardDeviation formula
   Dim theDeviation As Double = ((squaredsum _
    - (sum * theAverage)) _
   / (count - 1))
   ' Return standard deviation of UnitsInStock column
   Return Math.Sqrt(theDeviation)
  End Function
End Class

In C#:

using Infragistics; public class StandardDeviationCalc : SynchronousSummaryCalculator{
    public override SummaryExecution? SummaryExecution
    {
        get
        {
            return Infragistics.SummaryExecution.PriorToFilteringAndPaging;
        }
    }
     public override object Summarize(IQueryable data, string fieldKey)
    {
        ObservableCollection<Product> convertedData = DataUtil.Products;
        // Variables used for intermediate calculations
        double sum = 0;
        int count = 0;
        double squaredsum = 0;
        double tempVal = 0;
        foreach (Product item in convertedData)
        {
            // Value in UnitsInStock column
            tempVal = Convert.ToDouble(item.UnitsInStock);
            count++;
            // Sum values in UnitsInStock column
            sum += tempVal;
            // Square values in UnitsInStock column
            squaredsum += tempVal * tempVal;
        }
        if (count < 2 || sum == 0)
            return 0;
        // Calculate average of UnitsInStock column
        double theAverage = sum / count;
        // StandardDeviation formula
        double theDeviation = (squaredsum - sum * theAverage) / (count - 1);
        // Return standard deviation of UnitsInStock column
        return Math.Sqrt(theDeviation);
    }
}

Create your own custom class that derives from the SummaryOperandBase class and name it StandardDeviationOperand.

In Visual Basic:

Public Class StandardDeviationOperand
   Inherits SummaryOperandBase
   Private myCalc As StandardDeviationCalc
   Protected Overrides ReadOnly Property DefaultRowDisplayLabel As String
      Get
         Return "Standard Deviation"
      End Get
   End Property
   Protected Overrides ReadOnly Property DefaultSelectionDisplayLabel As String
      Get
         Return "Standard Deviation"
       End Get
   End Property
   Public Overrides ReadOnly Property SummaryCalculator As SummaryCalculatorBase
      Get
         If (myCalc Is Nothing) Then
            Me.myCalc = New StandardDeviationCalc
         End If
       Return Me.myCalc
     End Get
   End Property
End Class

In C#:

using Infragistics;  public class StandardDeviationOperand : SummaryOperandBase
{
    StandardDeviationCalc myCalc;
    protected override string DefaultRowDisplayLabel
    {
        get { return "Standard Deviation"; }
    }
    protected override string DefaultSelectionDisplayLabel
    {
        get { return "Standard Deviation"; }
    }
    public override SummaryCalculatorBase SummaryCalculator
    {
        get
        {
            if (myCalc == null)
            {
                this.myCalc = new StandardDeviationCalc();
            }
                        return this.myCalc;
        }
     }}

Add the new summary operand, StandardDeviationOperand, to the SummaryOperands collection on the UnitsInStock column.

In Visual Basic:

Me.MyDataGrid.Columns.DataColumns("UnitsInStock").SummaryColumnSettings.SummaryOperands.Add(New StandardDeviationOperand)

In C#:

// Add summary operand to UnitsInStock column
this.MyDataGrid.Columns.DataColumns["UnitsInStock"].SummaryColumnSettings.SummaryOperands.Add(new StandardDeviationOperand());

Save and run your application. You should see your custom Standard Deviation operand in the summary drop down for the UnitsInStock column.

WPF | Help Topics

Create a Custom Summary

Before You Begin

What You Will Accomplish

Follow these Steps

Related Topics