XtraReport.CalculatedFields Property

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

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v23.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 to create a calculated field at runtime, and bind the field to the report control’s Text property.

C#

using DevExpress.XtraReports.UI;
using DevExpress.XtraReports.Configuration;
// ...
// 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);

// Specify 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 the label's Text property to the calculated field.
report.FindControl("xrlabel3", true).ExpressionBindings
            .Add(new ExpressionBinding() {
                EventName = "BeforePrint",
                PropertyName = "Text",
                Expression = "FormatString('{0:c2}', [myField])"
            });

VB.NET

Imports DevExpress.XtraReports.UI
Imports DevExpress.XtraReports.Configuration
' ...
' 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 = "Calculated Field"
calcField.Name = "myField"
calcField.Expression = "[UnitPrice] * [UnitsInStock]"

' Bind a label's Text property to the calculated field.
report.FindControl("xrlabel3", True).ExpressionBindings.Add(New ExpressionBinding("BeforePrint", "Text", "FormatString('{0:c2}', [myField])"))

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