PivotGridFieldBase.DataBinding Property

Gets or sets an object that specifies the field’s source data (Optimized mode).

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.PivotGrid.v20.2.Core.dll

NuGet Packages: DevExpress.PivotGrid.Core, DevExpress.WindowsDesktop.PivotGrid.Core

Declaration

C#

[DefaultValue(null)]
public DataBindingBase DataBinding { get; set; }

VB.NET

<DefaultValue(Nothing)>
Public Property DataBinding As DataBindingBase

Property Value

Type	Default	Description
DataBindingBase	*null*	A DataBindingBase descendant that specifies the source data and calculation type.

Remarks

In Optimized mode use the DataBinding property to specify the field’s source data with the Data Binding API.

The key concept of the Data Binding API is the data binding source. All functionality related to calculations are encapsulated into the data binding source - the DataBindingBase descendant that is assigned to the field’s DataBinding property.

Note

The Data Binding API works in Optimized mode if the DataBinding property is set. Otherwise, the fields are divided into bound and unbound and the approach introduce earlier in Legacy mode is in effect.

The code snippet below demonstrates how to use the Data Binding API to calculate running totals.

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#

pivotGridControl.OptionsData.DataProcessingEngine = PivotDataProcessingEngine.Optimized;

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

PivotGridField fieldProductAmountRunningTotal = new PivotGridField {
    Area = PivotArea.DataArea,
    Caption = "Running Total",
    Name = "fRunningTotal"
};

DataSourceColumnBinding productAmountBinding = new DataSourceColumnBinding("ProductAmount");
//Bind a field to a column in the data source.
fieldProductAmount.DataBinding = productAmountBinding;
//Calculate a running summary of the column.
fieldProductAmountRunningTotal.DataBinding = new RunningTotalBinding() {
    Source = productAmountBinding,
    PartitioningCriteria = CalculationPartitioningCriteria.ColumnValue,
    SummaryType = PivotSummaryType.Sum
};

pivotGridControl.Fields.AddRange(new PivotGridField[] { fieldProductAmount, fieldProductAmountRunningTotal });

VB.NET

pivotGridControl.OptionsData.DataProcessingEngine = PivotDataProcessingEngine.Optimized

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

Dim fieldProductAmountRunningTotal As New PivotGridField()
fieldProductAmountRunningTotal.Area = PivotArea.DataArea
fieldProductAmountRunningTotal.Caption = "Running Total"
fieldProductAmountRunningTotal.Name = "fRunningTotal"

Dim productAmountBinding As New DataSourceColumnBinding("ProductAmount")
'Bind a field to a column in the data source.
fieldProductAmount.DataBinding = productAmountBinding
'Calculate a running summary on the column.
Dim runningTotalBinding As New RunningTotalBinding()
runningTotalBinding.Source = productAmountBinding
runningTotalBinding.PartitioningCriteria = CalculationPartitioningCriteria.ColumnValue
runningTotalBinding.SummaryType = PivotSummaryType.Sum
fieldProductAmountRunningTotal.DataBinding = runningTotalBinding

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

Related GitHub Examples

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

pivot-grid-aggr-examples/CS/Pivot-Aggr-Examples/CodeFiles/CodeExample.cs#L25

};
salesByYearByCountry.DataBinding = new ExpressionDataBinding("Aggr(Sum([Extended Price]), GetYear([OrderDate]), [Country])");
pivotGrid.Fields.Add(salesByYearByCountry);

winforms-pivotgrid--display-the-difference-of-income-and-outlay-in-totals/CS/PivotGridCustomSummaryExample/Form1.cs#L86

    ExpressionDataBinding savingsBinding = new ExpressionDataBinding("Sum(Iif([Type]='Income', [Value], -[Value]))");
    fieldValueTotal.DataBinding = savingsBinding;
}

VB.NET

pivot-grid-aggr-examples/VB/Pivot-Aggr-Examples/CodeFiles/CodeExample.vb#L24

salesByYearByCountry.FieldName = "SalesByYearByCountry"
salesByYearByCountry.DataBinding = New ExpressionDataBinding("Aggr(Sum([Extended Price]), GetYear([OrderDate]), [Country])")
pivotGrid.Fields.Add(salesByYearByCountry)

winforms-pivotgrid--display-the-difference-of-income-and-outlay-in-totals/VB/PivotGridCustomSummaryExample/Form1.vb#L71

    Dim savingsBinding As New ExpressionDataBinding("Sum(Iif([Type]='Income', [Value], -[Value]))")
    fieldValueTotal.DataBinding = savingsBinding
End Sub