PivotGridControl.CreateOLAPDrillDownDataSourceAsync(Int32, Int32, Int32, List<String>, AsyncCompletedHandler) Method

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

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.XtraPivotGrid.v20.1.dll

Declaration

[Obsolete("The CreateOLAPDrillDownDataSource method is obsolete now. Use the CreateDrillDownDataSource method instead.")]
public void CreateOLAPDrillDownDataSourceAsync(
    int columnIndex,
    int rowIndex,
    int maxRowCount,
    List<string> customColumns,
    AsyncCompletedHandler asyncCompleted
)
<Obsolete("The CreateOLAPDrillDownDataSource method is obsolete now. Use the CreateDrillDownDataSource method instead.")>
Public Sub CreateOLAPDrillDownDataSourceAsync(
    columnIndex As Integer,
    rowIndex As Integer,
    maxRowCount As Integer,
    customColumns As List(Of String),
    asyncCompleted As AsyncCompletedHandler
)

Parameters

Name Type Description
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.

maxRowCount Int32

An integer value that specifies the maximum number of data rows to be returned. -1 to retrieve all rows.

customColumns List<String>

A list of columns to be returned.

asyncCompleted AsyncCompletedHandler

A AsyncCompletedHandler delegate referencing a method that should be executed after the operation is completed. The drill-down data source is passed to this method as a parameter.

Remarks

The CreateOLAPDrillDownDataSourceAsync method is asynchronous. It starts executing the related operation in a background thread, and immediately returns control. The primary UI thread is not blocked, allowing the application to continue responding to end-user actions. For more information about the asynchronous mode, see Asynchronous Mode.

The drill-down data source (a PivotDrillDownDataSource instance) is passed to the asyncCompleted delegate via the result parameter. This parameter returns an AsyncOperationResult instance. Use the AsyncOperationResult.Value property to obtain the drill-down data source.

To obtain a drill-down data source in OLAP mode synchronously, use the PivotGridControl.CreateOLAPDrillDownDataSource method.

To obtain the name of a column in a data source to which a pivot field corresponds, use the field's PivotGridFieldBase.OLAPDrillDownColumnName property.

NOTE

For MS SQL Server Analysis Services 2000, the customColumns parameter is ignored. In this instance, the CreateOLAPDrillDownDataSourceAsync 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 CreateOLAPDrillDownDataSourceAsync 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 CreateOLAPDrillDownDataSourceAsync method.

NOTE

The CreateOLAPDrillDownDataSourceAsync 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 CreateOLAPDrillDownDataSourceAsync method throws an exception.

See Also