Skip to main content

PivotGridControl.OlapConnectionString Property

Gets or sets a connection string to a cube in an MS Analysis Services database.

Namespace: DevExpress.Xpf.PivotGrid

Assembly: DevExpress.Xpf.PivotGrid.v22.1.dll

Declaration

public string OlapConnectionString { get; set; }

Property Value

Type Description
String

A String that specifies a connection string to a cube in an MS Analysis Services database.

Remarks

To retrieve data from an OLAP cube asynchronously, use the PivotGridControl.SetOlapConnectionStringAsync method to specify a connection string.

A sample connection string is shown below:

OlapConnectionString=”Provider=msolap;Data Source=localhost;Initial Catalog=Adventure Works DW;Cube Name=Adventure Works;Query Timeout=100;”

The connection string has the following parameters:

  • Provider - Identifies a data provider to be used. The “msolap” string identifies the latest version of Microsoft SQL Server Analysis Services (SSAS);

    Important

    Note that the Provider parameter is in effect only for the OLE DB provider for Analysis Services specified using the PivotGridControl.OlapDataProvider property.

  • Data Source - Specifies the name of a server that runs an instance of SSAS;
  • Initial Catalog - Specifies a data catalog that contains cubes;
  • Cube Name - Specifies the name of a cube that provides OLAP data;
  • Query Timeout (optional) - The maximum amount of time, in seconds, to wait for a query to SSAS to complete. If the parameter is set to 0, each query can last indefinitly.

Example

Imports System.Windows
Imports DevExpress.Xpf.PivotGrid

Namespace HowToBindOLAP

    Public Partial Class MainWindow
        Inherits Window

        Public Sub New()
            Me.InitializeComponent()
        End Sub

        Private Sub Window_Loaded(ByVal sender As Object, ByVal e As RoutedEventArgs)
            Me.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;"
            Me.pivotGridControl1.BeginUpdate()
            ' Create fields.
            Dim fieldMeasuresInternetSalesAmount As PivotGridField = New PivotGridField()
            fieldMeasuresInternetSalesAmount.Caption = "Internet Sales Amount"
            fieldMeasuresInternetSalesAmount.Area = FieldArea.DataArea
            Dim fieldCustomerCountryCountry As PivotGridField = New PivotGridField()
            fieldCustomerCountryCountry.Caption = "Country"
            fieldCustomerCountryCountry.Area = FieldArea.RowArea
            Dim fieldDateFiscalYearFiscalYear As PivotGridField = New PivotGridField()
            fieldDateFiscalYearFiscalYear.Caption = "Fiscal Year"
            fieldDateFiscalYearFiscalYear.Area = FieldArea.ColumnArea
            Dim fieldSales As PivotGridField = New PivotGridField()
            fieldSales.Caption = "Cleared Amount"
            fieldSales.Area = FieldArea.DataArea
            fieldSales.CellFormat = "c"
            ' Populate fields with data.
            fieldMeasuresInternetSalesAmount.DataBinding = New DataSourceColumnBinding("[Measures].[Internet Sales Amount]")
            fieldCustomerCountryCountry.DataBinding = New DataSourceColumnBinding("[Customer].[Country].[Country]")
            fieldDateFiscalYearFiscalYear.DataBinding = New DataSourceColumnBinding("[Date].[Fiscal Year].[Fiscal Year]")
            fieldSales.DataBinding = New OlapExpressionBinding("[Measures].[Internet Sales Amount] * 0.87")
            ' Add fields to the PivotGridControl.
            Me.pivotGridControl1.Fields.AddRange(fieldMeasuresInternetSalesAmount, fieldCustomerCountryCountry, fieldDateFiscalYearFiscalYear, fieldSales)
            Me.pivotGridControl1.EndUpdate()
        End Sub
    End Class
End Namespace
<Window xmlns:dxpg="http://schemas.devexpress.com/winfx/2008/xaml/pivotgrid" 
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        x:Class="HowToBindOLAP.MainWindow"
        Title="MainWindow" Loaded="Window_Loaded"
        Height="350" Width="525">
    <Grid>
        <dxpg:PivotGridControl HorizontalAlignment="Left" VerticalAlignment="Top" 
                               Name="pivotGridControl1" />
    </Grid>
</Window>
See Also