corelibraries-devexpress-dot-xtrapivotgrid-dot-pivotgridfieldbase-ea5c4f60.md
Gets or sets an expression used to evaluate values for the current unbound field in OLAP.
Namespace : DevExpress.XtraPivotGrid
Assembly : DevExpress.PivotGrid.v25.2.Core.dll
NuGet Packages : DevExpress.PivotGrid.Core, DevExpress.Win.Navigation
[DefaultValue(null)]
public string OLAPExpression { get; set; }
<DefaultValue(Nothing)>
Public Property OLAPExpression As String
| Type | Default | Description |
|---|---|---|
| String | null |
A string that represents an expression used to evaluate values for the current field in OLAP.
|
This example demonstrates how to specify connection settings and create fields that are bound to measures and dimensions of the cube on the OLAP server.
Follow the steps below to bind the Pivot Grid control to an OLAP cube in code.
You can create Pivot Grid fields and bind them to measures and dimensions in the OLAP cube in the following ways:
Call the PivotGridControl.RetrieveFields method to create Pivot Grid fields for all columns in a data source and add them to the field’s collection. Use the PivotGridControl.GetFieldList method to obtain a list of fields available in a bound data source.
Create a PivotGridField object and add it to the PivotGridControl.Fields collection. Then, use DataSourceColumnBinding and OLAPExpressionBinding to bind the field to data.
Specify the value of the PivotGridFieldBase.Name property for each field when you create Pivot Grid fields. You can use this value to determine fields in a stored layout.
Use the following properties to specify field settings:
PivotGridFieldBase.AreaGets or sets the area in which the field is displayed.PivotGridFieldBase.AreaIndexGets or sets the field’s index from among the other fields displayed within the same area.PivotGridFieldBase.VisibleGets or sets whether the field is visible.
Use the invoked Customization Form to arrange fields.
View Example: How to Connect a Pivot Grid to an OLAP Data Source
using DevExpress.XtraPivotGrid;
using DevExpress.XtraPivotGrid.Customization;
namespace WinOlapRetrieveFieldsExample {
public partial class Form1 : DevExpress.XtraEditors.XtraForm {
public Form1() {
InitializeComponent();
// Specify the OLAP connection settings.
pivotGridControl1.OLAPDataProvider = OLAPDataProvider.Adomd;
pivotGridControl1.OLAPConnectionString =
@"Provider=MSOLAP;
Data Source=http://demos.devexpress.com/Services/OLAP/msmdpump.dll;
Initial catalog=Adventure Works DW Standard Edition;
Cube name=Adventure Works;
Query Timeout=100;";
// Set the Customization Forms style.
pivotGridControl1.OptionsCustomization.CustomizationFormStyle = CustomizationFormStyle.Excel2007;
// Invoke the Customization Form.
pivotGridControl1.FieldsCustomization();
}
private void btnRetrieveFields_Click(object sender, System.EventArgs e) {
// Retrieve fields.
pivotGridControl1.RetrieveFields(PivotArea.ColumnArea, false);
foreach (PivotGridField field in pivotGridControl1.Fields){
field.Name = "field" + (field.DataBinding as DataSourceColumnBinding).ColumnName;
}
// Add fields from the Field List to the specified area to create a report.
pivotGridControl1.BeginUpdate();
pivotGridControl1.Fields["[Customer].[Country].[Country]"].Area = PivotArea.RowArea;
pivotGridControl1.Fields["[Customer].[Country].[Country]"].Visible = true;
pivotGridControl1.Fields["[Customer].[City].[City]"].Area = PivotArea.RowArea;
pivotGridControl1.Fields["[Customer].[City].[City]"].Visible = true;
pivotGridControl1.Fields["[Date].[Fiscal].[Fiscal Year]"].Area = PivotArea.ColumnArea;
pivotGridControl1.Fields["[Date].[Fiscal].[Fiscal Year]"].Visible = true;
pivotGridControl1.Fields["[Measures].[Internet Sales Amount]"].Visible = true;
pivotGridControl1.EndUpdate();
// Resize columns automatically.
pivotGridControl1.BestFit();
// Invoke the Customization Form.
pivotGridControl1.FieldsCustomization();
}
private void btnCreateFields_Click(object sender, System.EventArgs e) {
pivotGridControl1.BeginUpdate();
pivotGridControl1.Fields.Clear();
// Create a field, specify its settings and bind the field to a measure or dimension.
PivotGridField fieldCountry = pivotGridControl1.Fields.Add("Country", PivotArea.RowArea);
fieldCountry.DataBinding = new DataSourceColumnBinding("[Customer].[Country].[Country]");
fieldCountry.Name = "fieldCountry";
PivotGridField fieldCity = pivotGridControl1.Fields.Add("City", PivotArea.RowArea);
fieldCity.DataBinding = new DataSourceColumnBinding("[Customer].[City].[City]");
fieldCity.Name = "fieldCity";
PivotGridField measureField = new PivotGridField() { Caption = "Cleared Amount",
Area = PivotArea.DataArea };
measureField.DataBinding = new OLAPExpressionBinding("[Measures].[Internet Sales Amount] * 0.87");
measureField.Name = "fieldInternetSalesAmount";
pivotGridControl1.Fields.Add(measureField);
PivotGridFieldBase fieldTop10 = pivotGridControl1.Fields.Add("Top10", PivotArea.ColumnArea);
fieldTop10.DataBinding = new OLAPExpressionBinding("TOPCOUNT([Date].[Date].[Date].MEMBERS, 10, " +
"[Measures].[Internet Sales Amount])");
fieldTop10.Visible = false;;
fieldTop10.Name = "fieldTopcount";
pivotGridControl1.EndUpdate();
// Invoke the Customization Form.
pivotGridControl1.FieldsCustomization();
}
}
}
Imports DevExpress.XtraPivotGrid
Imports DevExpress.XtraPivotGrid.Customization
Namespace WinOlapRetrieveFieldsExample
Public Partial Class Form1
Inherits DevExpress.XtraEditors.XtraForm
Public Sub New()
InitializeComponent()
' Specify the OLAP connection settings.
pivotGridControl1.OLAPDataProvider = OLAPDataProvider.Adomd
pivotGridControl1.OLAPConnectionString = "Provider=MSOLAP;
Data Source=http://demos.devexpress.com/Services/OLAP/msmdpump.dll;
Initial catalog=Adventure Works DW Standard Edition;
Cube name=Adventure Works;
Query Timeout=100;"
' Set the Customization Forms style.
pivotGridControl1.OptionsCustomization.CustomizationFormStyle = CustomizationFormStyle.Excel2007
' Invoke the Customization Form.
pivotGridControl1.FieldsCustomization()
End Sub
Private Sub btnRetrieveFields_Click(ByVal sender As Object, ByVal e As System.EventArgs)
' Retrieve fields.
pivotGridControl1.RetrieveFields(PivotArea.ColumnArea, False)
For Each field As PivotGridField In pivotGridControl1.Fields
field.Name = "field" & TryCast(field.DataBinding, DataSourceColumnBinding).ColumnName
Next
' Add fields from the Field List to the specified area to create a report.
pivotGridControl1.BeginUpdate()
pivotGridControl1.Fields("[Customer].[Country].[Country]").Area = PivotArea.RowArea
pivotGridControl1.Fields("[Customer].[Country].[Country]").Visible = True
pivotGridControl1.Fields("[Customer].[City].[City]").Area = PivotArea.RowArea
pivotGridControl1.Fields("[Customer].[City].[City]").Visible = True
pivotGridControl1.Fields("[Date].[Fiscal].[Fiscal Year]").Area = PivotArea.ColumnArea
pivotGridControl1.Fields("[Date].[Fiscal].[Fiscal Year]").Visible = True
pivotGridControl1.Fields("[Measures].[Internet Sales Amount]").Visible = True
pivotGridControl1.EndUpdate()
' Resize columns automatically.
pivotGridControl1.BestFit()
' Invoke the Customization Form.
pivotGridControl1.FieldsCustomization()
End Sub
Private Sub btnCreateFields_Click(ByVal sender As Object, ByVal e As System.EventArgs)
pivotGridControl1.BeginUpdate()
pivotGridControl1.Fields.Clear()
' Create a field, specify its settings and bind the field to a measure or dimension.
Dim fieldCountry As PivotGridField = pivotGridControl1.Fields.Add("Country", PivotArea.RowArea)
fieldCountry.DataBinding = New DataSourceColumnBinding("[Customer].[Country].[Country]")
fieldCountry.Name = "fieldCountry"
Dim fieldCity As PivotGridField = pivotGridControl1.Fields.Add("City", PivotArea.RowArea)
fieldCity.DataBinding = New DataSourceColumnBinding("[Customer].[City].[City]")
fieldCity.Name = "fieldCity"
Dim measureField As PivotGridField = New PivotGridField() With {.Caption = "Cleared Amount", .Area = PivotArea.DataArea}
measureField.DataBinding = New OLAPExpressionBinding("[Measures].[Internet Sales Amount] * 0.87")
measureField.Name = "fieldInternetSalesAmount"
pivotGridControl1.Fields.Add(measureField)
Dim fieldTop10 As PivotGridFieldBase = pivotGridControl1.Fields.Add("Top10", PivotArea.ColumnArea)
fieldTop10.DataBinding = New OLAPExpressionBinding("TOPCOUNT([Date].[Date].[Date].MEMBERS, 10, " & "[Measures].[Internet Sales Amount])")
fieldTop10.Visible = False
fieldTop10.Name = "fieldTopcount"
pivotGridControl1.EndUpdate()
' Invoke the Customization Form.
pivotGridControl1.FieldsCustomization()
End Sub
End Class
End Namespace
The following code snippet (auto-collected from DevExpress Examples) contains a reference to the OLAPExpression 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.
winforms-pivot-grid-connect-to-an-olap-datasource/CS/WinOlapRetrieveFieldsExample/Form1.cs#L57
PivotGridFieldBase fieldCountry = pivotGridControl1.Fields.Add("Country", PivotArea.RowArea);
fieldCountry.OLAPExpression = "[Customer].[Country].[Country]";
fieldCountry.OLAPDimensionCaption = "Location";
winforms-pivot-grid-connect-to-an-olap-datasource/VB/WinOlapRetrieveFieldsExample/Form1.vb#L49
Dim fieldCountry As PivotGridFieldBase = pivotGridControl1.Fields.Add("Country", PivotArea.RowArea)
fieldCountry.OLAPExpression = "[Customer].[Country].[Country]"
fieldCountry.OLAPDimensionCaption = "Location"
See Also