PivotGridFieldBase.ExpressionFieldName Property

Gets the field’s name in unbound expressions.

Namespace: DevExpress.XtraPivotGrid

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

NuGet Packages: DevExpress.PivotGrid.Core, DevExpress.Win.Navigation

Declaration

C#

[Browsable(false)]
public string ExpressionFieldName { get; }

VB.NET

<Browsable(False)>
Public ReadOnly Property ExpressionFieldName As String

Property Value

Type	Description
String	A String representing the field’s name in unbound expressions.

Remarks

Note

This member is not supported in Optimized, OLAP, and Server modes. Use ExpressionDataBinding/OlAPExpressionBinding instead.

The examples below show how to create unbound fields in code and supply them with data using expressions. Note that the ExpressionFieldName property is utilized to use other fields within an expression.

• Example 1

  The following code snippet demonstrates how to create an unbound field in code and supply this field with data using the PivotGridField.UnboundExpression property. In this example, full names are generated based on the first and last names stored in the underlying data source.

  C#

  using DevExpress.XtraPivotGrid;
  
  public Form1() {
      // ... 
              PivotGridField fieldFullName = new PivotGridField() { Caption = "Full Name", Area = PivotArea.RowArea };
  
              fieldFullName.UnboundFieldName = "fieldFullName";
              fieldFullName.UnboundType = DevExpress.Data.UnboundColumnType.String;
              fieldFullName.UnboundExpression = 
                  "[" + fieldFirstName1.ExpressionFieldName + "]" + 
                  "+" + "' '" + "+" +
                  "[" + fieldLastName1.ExpressionFieldName + "]";
  
              pivotGridControl1.Fields.Add(fieldFullName);
  }
  

  VB.NET

  Imports DevExpress.XtraPivotGrid
  
  Public Sub New()
      ' ...  
              Dim fieldFullName As New PivotGridField() With {.Caption = "Full Name", .Area = PivotArea.RowArea}
  
              fieldFullName.UnboundFieldName = "fieldFullName"; 
              fieldFullName.UnboundType = DevExpress.Data.UnboundColumnType.String
              fieldFullName.UnboundExpression = "[" & fieldFirstName1.ExpressionFieldName & "]" & "+" & "' '" & "+" & "[" & fieldLastName1.ExpressionFieldName & "]"
  
              pivotGridControl1.Fields.Add(fieldFullName)
  End Sub
  

• Example 2

  The following code snippet demonstrates how to create an unbound field in code and use the PivotGridField.UnboundExpression property to supply data. In this example, extended price values are calculated as follows:

  [Quantity] * [UnitPrice] * (1 - [Discount]).

  Pivot Grid field names are obtained using the PivotGridFieldBase.ExpressionFieldName property.

  C#

  PivotGridField fieldExtendedPrice = new PivotGridField() { Caption = "Extended Price", Area = PivotArea.DataArea };
  fieldExtendedPrice.UnboundFieldName = "fieldExtendedPrice";
  fieldExtendedPrice.UnboundType = DevExpress.Data.UnboundColumnType.Decimal;
  fieldExtendedPrice.UnboundExpression = string.Format("[{0}] * [{1}] * (1 - [{2}])", 
      fieldQuantity.ExpressionFieldName, fieldUnitPrice.ExpressionFieldName, fieldDiscount.ExpressionFieldName);
  pivotGridControl1.Fields.Add(fieldExtendedPrice);
  }
  

  VB.NET

  Dim fieldExtendedPrice As New PivotGridField() With {.Caption = "Extended Price", .Area = PivotArea.DataArea}
  fieldExtendedPrice.UnboundFieldName = "fieldExtendedPrice"
  fieldExtendedPrice.UnboundType = DevExpress.Data.UnboundColumnType.Decimal
  fieldExtendedPrice.UnboundExpression = String.Format("[{0}] * [{1}] * (1 - [{2}])", fieldQuantity.ExpressionFieldName, fieldUnitPrice.ExpressionFieldName, fieldDiscount.ExpressionFieldName)
  pivotGridControl1.Fields.Add(fieldExtendedPrice)
  

Related GitHub Examples

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

winforms-pivot-grid-display-kpi-graphics/CS/WindowsFormsApp_RegularDataSourceKPI/Form1.cs#L20

    string.Format("(Iif(Sum([{0}])<100000,-1,Iif(Sum([{0}])<150000,0,1)))",
    fieldExtendedPrice.ExpressionFieldName));
// Sets the Data Header Area within which the "Status" Field can be positioned.

VB.NET

winforms-pivot-grid-display-kpi-graphics/VB/WindowsFormsApp_RegularDataSourceKPI/Form1.vb#L22

' Sets a column's data binding and specifies an expression.
KPIField.DataBinding = New ExpressionDataBinding(String.Format("(Iif(Sum([{0}])<100000,-1,Iif(Sum([{0}])<150000,0,1)))", fieldExtendedPrice.ExpressionFieldName))
' Sets the Data Header Area within which the "Status" Field can be positioned.