PivotFieldImageIndexEventArgs.CreateOLAPDrillDownDataSource(Int32, List<String>) Method
OBSOLETE
The CreateOLAPDrillDownDataSource method is obsolete now. Use the CreateDrillDownDataSource() method instead.
In OLAP mode, returns a list of records used to calculate a summary value for the current cell. Allows you to specify the columns and limit the number of records to be returned.
Namespace: DevExpress.XtraPivotGrid
Assembly: DevExpress.XtraPivotGrid.v24.1.dll
NuGet Package: DevExpress.Win.PivotGrid
Declaration
[Obsolete("The CreateOLAPDrillDownDataSource method is obsolete now. Use the CreateDrillDownDataSource method instead.")]
public PivotDrillDownDataSource CreateOLAPDrillDownDataSource(
int maxRowCount,
List<string> customColumns
)Parameters
| Name | Type | Description |
|---|---|---|
| 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. |
Returns
| Type | Description |
|---|---|
| PivotDrillDownDataSource | A PivotDrillDownDataSource object that contains the underlying data. |
Remarks
To obtain the name of a column in a data source to which a pivot field corresponds, use the PivotGridFieldBase.OLAPDrillDownColumnName property.
Note
If you call the CreateOLAPDrillDownDataSource method while an asynchronous operation is being performed, an exception will be thrown. To determine whether the operation is in progress, use the pivot grid’s IThreadSafeAccessible.IsAsyncInProgress property. For more information, see Asynchronous Mode.
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.