CalculatedField Class

Provides the functionality for calculated fields.

Namespace: DevExpress.Snap.Core.API

Assembly: DevExpress.Snap.v18.1.Core.dll

Declaration

C#

public class CalculatedField :
    IDisplayNamePropertyContainer,
    ICalculatedField,
    IComponent,
    IDisposable,
    ICloneable<CalculatedField>

VB.NET

Public Class CalculatedField
    Implements IDisplayNamePropertyContainer,
               ICalculatedField,
               IComponent,
               IDisposable,
               ICloneable(Of CalculatedField)

Related API Members

The following members accept/return CalculatedField objects:

• CalculatedField.Clone()

Remarks

The CalculatedField class allows you to specify a logical expression for a calculated field. In a Snap project, this expression is defined by the Expression Editor.

Calculated fields are contained in the CalculatedFieldCollection. Use the DataSourceInfo.CalculatedFields property to access the data source’s calculated fields. The IDataSourceOwner.CalculatedFields property obtains the snap document’s collection of calculated fields.

A calculated field created from the UI is added to the data source’s collection.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the CalculatedField class.

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-report-api-examples-t429162/CS/SnapServerExamples/CodeExamples/DataVisualizationToolsActions.cs#L91

server.Document.BeginUpdate();
CalculatedField field = new CalculatedField("newField", "Products");
field.FieldType = DevExpress.XtraReports.UI.FieldType.Int32;

VB.NET

snap-report-api-examples-t429162/VB/SnapServerExamples/CodeExamples/DataVisualizationToolsActions.vb#L84

server.Document.BeginUpdate()
Dim field As New CalculatedField("newField", "Products")
field.FieldType = DevExpress.XtraReports.UI.FieldType.Int32

Inheritance

Object

CalculatedField