CalculatedFieldCollection Class

A collection of CalculatedField objects.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v18.2.dll

Declaration

C#
VB.NET

public class CalculatedFieldCollection :
    Collection<CalculatedField>,
    IEnumerable<ICalculatedField>,
    IEnumerable,
    IDisposable

Public Class CalculatedFieldCollection
    Inherits Collection(Of CalculatedField)
    Implements IEnumerable(Of ICalculatedField),
               IEnumerable,
               IDisposable

The following members return CalculatedFieldCollection objects:

Remarks

This collection is returned via the XtraReport.CalculatedFields property. For more information on using calculated data fields in XtraReports, refer to the Calculated Fields Overview document.

Example

This example demonstrates how a calculated field can be created at runtime and bound to a control’s XRControl.Text property.

C#
VB.NET

using System;
using System.Windows.Forms;
using DevExpress.XtraReports.UI;
using DevExpress.XtraReports.Configuration;
// ...

private void button1_Click(object sender, EventArgs e) {

    // Create a report.
    XtraReport1 report = new XtraReport1();

    // Create a calculated field 
    // and add it to the report's collection.
    CalculatedField calcField = new CalculatedField();
    report.CalculatedFields.Add(calcField);

    // Define the calculated field's properties.
    calcField.DataSource = report.DataSource;
    calcField.DataMember = report.DataMember;
    calcField.FieldType = FieldType.Double;
    calcField.DisplayName = "Calculated Field";
    calcField.Name = "myField";
    calcField.Expression = "[UnitPrice] * [UnitsInStock]";

    // Bind a label's Text property to the calculated field.
    report.FindControl("xrlabel2", true).DataBindings.Add("Text", null, "Order Details.myField");

    // Bind a label's Text property to the calculated field 
    // depending on the report's data binding mode.
    if (Settings.Default.UserDesignerOptions.DataBindingMode == DataBindingMode.Bindings)
        report.FindControl("xrlabel3", true).DataBindings.Add("Text", null, "Products.myField", "{0:c2}");
    else report.FindControl("xrlabel3", true).ExpressionBindings.Add(
        new ExpressionBinding("BeforePrint", "Text", "FormatString('{0:c2}', [myField])"));

    // Display the report.
    ReportPrintTool printTool = new ReportPrintTool(report);
    printTool.ShowPreviewDialog();
}

Imports System
Imports System.Windows.Forms
Imports DevExpress.XtraReports.UI
Imports DevExpress.XtraReports.Configuration
' ...

Private Sub button1_Click(ByVal sender As Object, ByVal e As EventArgs) Handles button1.Click

    ' Create a report.
    Dim report As New XtraReport1()

    ' Create a calculated field, 
    ' and add it to the report's collection.
    Dim calcField As New CalculatedField()
    report.CalculatedFields.Add(calcField)

    ' Define the calculated field's properties.
    calcField.DataSource = report.DataSource
    calcField.DataMember = report.DataMember
    calcField.FieldType = FieldType.Double
    calcField.DisplayName = "A Calculated Field"
    calcField.Name = "myField"
    calcField.Expression = "[UnitPrice] * [Quantity]"

    ' Bind a label's Text property to the calculated field     
    ' depending on the report's data binding mode.    
    If Settings.Default.UserDesignerOptions.DataBindingMode = DataBindingMode.Bindings Then
        report.FindControl("xrlabel3", True).DataBindings.Add("Text", Nothing, "Products.myField", "{0:c2}")
    Else
        report.FindControl("xrlabel3", True).ExpressionBindings.Add(
            New ExpressionBinding("BeforePrint", "Text", "FormatString('{0:c2}', [myField])"))    
    End If

    ' Display the report.
    Dim pt As New ReportPrintTool(report)
    pt.ShowPreviewDialog()
End Sub