XtraReport.CalculatedFields Property

Provides access to a report’s collection of calculated fields.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v21.2.dll

NuGet Package: DevExpress.Reporting.Core

Declaration

C#

[SRCategory(ReportStringId.CatData)]
public CalculatedFieldCollection CalculatedFields { get; }

VB.NET

<SRCategory(ReportStringId.CatData)>
Public ReadOnly Property CalculatedFields As CalculatedFieldCollection

Property Value

Type	Description
CalculatedFieldCollection	A CalculatedFieldCollection object.

Remarks

For general information, see Calculated Fields Overview.

For a step-by-step tutorial, see Using Calculated Fields.

Example

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

C#

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("xrlabel1", true).ExpressionBindings.Add(new ExpressionBinding("BeforePrint", "Text", "FormatString('{0:c2}', [myField])"));

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

VB.NET

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.
    report.FindControl("xrlabel1", True).ExpressionBindings.Add(New ExpressionBinding("BeforePrint", "Text", "FormatString('{0:c2}', [myField])"))

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

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the CalculatedFields 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#

snap-convert-snx-to-repx/CS/SnxToRepx/Converter/ReportGenerator.cs#L162

        //If the field's name equals to the specified name, return the field
        return report.CalculatedFields[i];
//Otherwise, return null

VB.NET

snap-convert-snx-to-repx/VB/SnxToRepx/Converter/ReportGenerator.vb#L143

    'If the field's name equals to the specified name, return the field
    If Equals(report.CalculatedFields(i).DisplayName, displayName) Then Return report.CalculatedFields(i)
Next