CalculatedField Class

A calculated field that allows you to apply complex expressions to data fields obtained from the data source.

Namespace: DevExpress.DashboardCommon

Assembly: DevExpress.Dashboard.v24.1.Core.dll

NuGet Package: DevExpress.Dashboard.Core

Declaration

C#

public class CalculatedField :
    INamedItem,
    INameContainer,
    ISupportPrefix

VB.NET

Public Class CalculatedField
    Implements INamedItem,
               INameContainer,
               ISupportPrefix

Related API Members

The following members return CalculatedField objects:

• CalculatedFieldCollection.Add(String, String, CalculatedFieldType)
• CalculatedFieldCollection.Add(String, String, String, CalculatedFieldType)
• CalculatedFieldCollection.Add(String, String, String)
• CalculatedFieldCollection.Add(String, String)
• CalculatedFieldCollection.Add(String)

Remarks

The DevExpress Dashboard allows you to create calculated fields for the following data source types:

• DashboardSqlDataSource
• DashboardExcelDataSource
• DashboardEFDataSource
• DashboardObjectDataSource
• DashboardExtractDataSource
• DashboardFederationDataSource

To manage calculated fields of the specified data source, use the CalculatedFields property (for instance, DashboardSqlDataSource.CalculatedFields for SQL data sources or DashboardExcelDataSource.CalculatedFields for Excel data sources).

To learn more about calculated fields, see the following topics.

• Calculated Fields - Overview
• WinForms Designer - Creating Calculated Fields
• Web Dashboard - Creating Calculated Fields

Example

The following code snippet shows how to create a new calculated field based on the values of the ‘UnitPrice’ and ‘Discount’ data fields, and add it to the existing DashboardSqlDataSource.

C#

using DevExpress.DashboardCommon;
//...

            CalculatedField priceWithDiscount = new CalculatedField("[UnitPrice] * (1 - [Discount])");
            priceWithDiscount.DataMember = "SalesPerson";
            priceWithDiscount.Name = "Price with discount";
            sqlDataSource.CalculatedFields.Add(priceWithDiscount);

VB.NET

Imports DevExpress.DashboardCommon
'...

            Dim priceWithDiscount As New CalculatedField("[UnitPrice] * (1 - [Discount])")
            priceWithDiscount.DataMember = "SalesPerson"
            priceWithDiscount.Name = "Price with discount"
            sqlDataSource.CalculatedFields.Add(priceWithDiscount)

Inheritance

Object

CalculatedField