PivotGridExtension.CreateOLAPDrillDownDataSource(PivotGridSettings, String, Int32, Int32, List<String>) Method

In OLAP mode, returns a list of records used to calculate a summary value for the specified cell. Allows you to specify the columns to be returned.

Namespace: DevExpress.Web.Mvc

Assembly: DevExpress.Web.Mvc5.v24.1.dll

NuGet Package: DevExpress.Web.Mvc5

Declaration

C#

public static PivotDrillDownDataSource CreateOLAPDrillDownDataSource(
    PivotGridSettings pivotGridSettings,
    string connectionString,
    int columnIndex,
    int rowIndex,
    List<string> customColumns
)

VB.NET

Public Shared Function CreateOLAPDrillDownDataSource(
    pivotGridSettings As PivotGridSettings,
    connectionString As String,
    columnIndex As Integer,
    rowIndex As Integer,
    customColumns As List(Of String)
) As PivotDrillDownDataSource

Parameters

Name	Type	Description
pivotGridSettings	PivotGridSettings	A PivotGridSettings object that contains PivotGrid settings.
connectionString	String	A String that specifies the connection string to an OLAP cube.
columnIndex	Int32	A zero-based integer which identifies the visible index of the column.
rowIndex	Int32	A zero-based integer which identifies the visible index of the row.
customColumns	List<String>	A list of columns in a datasource, to be returned.

Returns

Type	Description
PivotDrillDownDataSource	A PivotDrillDownDataSource object that contains the underlying data.

Remarks

To obtain the name of a column in a datasource to which a pivot field corresponds, use the field’s OLAPDrillDownColumnName property.

Note

For MS SQL Server Analysis Services 2000, the customColumns parameter is ignored. In this instance, the CreateOLAPDrillDownDataSource method returns the granularity attributes.

Note

A note for MS SQL Server Analysis Services 2005 and 2008. If the customColumns list is null or empty, the CreateOLAPDrillDownDataSource method returns the columns corresponding to the current column, row and data PivotGrid fields. In addition, it returns filter fields if a filter is applied to them. Otherwise, it returns the columns specified by the customColumns list.

Note

If a filter is applied to a field, then that filter is taken into account if the corresponding drill-down column was returned from the server by the CreateOLAPDrillDownDataSource method.

Note

The CreateOLAPDrillDownDataSource method is not supported for cells corresponding to calculated measures.

Note

If multiple filter items are selected in a Filter Field, the drill-down data source cannot be created due to an MS SQL Server Analysis Services limitation. In this instance, the CreateOLAPDrillDownDataSource method throws an exception.