DifferenceBinding Class

Defines the difference calculation between values across a window.

Assembly: DevExpress.XtraPivotGrid.v21.1.dll

Declaration

C#
VB.NET

public class DifferenceBinding :
    DifferenceBindingBase

Public Class DifferenceBinding
    Inherits DifferenceBindingBase

Remarks

To bind a PivotGrid field to the result of the difference window calculations, do the following:

Create an instance of the DifferenceBinding class with the Source property set to the DataBindingBase descendant instance.
Specify the window frame and calculation settings.
Assign the DifferenceBinding instance to the PivotGridField.DataBinding property.

Example

The following code snippet illustrates the use of the Data Binding API:

NOTE

The complete sample project is available in the DevExpress Demo Center: Code Examples - Optimized Mode - Field Calculation Bindings module in the XtraPivotGrid MainDemo.

C#
VB.NET

pivotGridControl.OptionsData.DataProcessingEngine = PivotDataProcessingEngine.Optimized;

PivotGridField fieldProductAmount = new PivotGridField()
{
    Area = PivotArea.DataArea,
    Caption = "Product Sales",
    Name = "fProductAmount"
};

PivotGridField fieldProductAmountDifference = new PivotGridField()
{
    Area = PivotArea.DataArea,
    Caption = "Difference",
    Name = "fDifference"

};
DataSourceColumnBinding productAmountBinding = new DataSourceColumnBinding("ProductAmount");
//Bind a field to a column in the data source.
fieldProductAmount.DataBinding = productAmountBinding;
//Calculate a difference between the preceding and current value in the column.
fieldProductAmountDifference.DataBinding = new DifferenceBinding()
{
    Source = productAmountBinding,
    PartitioningCriteria = CalculationPartitioningCriteria.ColumnValue,
    Target = DifferenceTarget.Previous,
    DifferenceType = DifferenceType.Absolute
};
pivotGridControl.Fields.AddRange(new PivotGridField[] {
    fieldProductAmount,
    fieldProductAmountDifference
});

pivotGridControl.OptionsData.DataProcessingEngine = PivotDataProcessingEngine.Optimized

Dim fieldProductAmount As New PivotGridField()
fieldProductAmount.Area = PivotArea.DataArea
fieldProductAmount.Caption = "Product Sales"
fieldProductAmount.Name = "fProductAmount"

Dim fieldProductAmountDifference As New PivotGridField()
fieldProductAmountDifference.Area = PivotArea.DataArea
fieldProductAmountDifference.Caption = "Difference"
fieldProductAmountDifference.Name = "fDifference"

Dim productAmountBinding As New DataSourceColumnBinding("ProductAmount")
'Bind a field to a column in the data source.
fieldProductAmount.DataBinding = productAmountBinding
'Calculate a difference between the preceding and current value in the column.
Dim differenceBinding As New RunningTotalBinding()
differenceBinding.Source = productAmountBinding
differenceBinding.PartitioningCriteria = CalculationPartitioningCriteria.ColumnValue
differenceBinding.Target = DifferenceTarget.Previous
differenceBinding.DifferenceType = DifferenceType.Absolute
fieldProductAmountDifference.DataBinding = differenceBinding

pivotGridControl.Fields.AddRange(New PivotGridField() { fieldProductAmount, fieldProductAmountDifference})