PivotGridControl.CreateDrillDownDataSourceAsync(Int32, Int32, Int32, List<String>, AsyncCompletedHandler) Method
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.v18.2.dll
Declaration
public void CreateDrillDownDataSourceAsync(
int columnIndex,
int rowIndex,
int maxRowCount,
List<string> customColumns,
AsyncCompletedHandler asyncCompleted
)Parameters
| Name | Type | Description |
|---|---|---|
| columnIndex | Int32 | A zero-based integer which identifies the visible index of the column. Pass -1 as a column index to obtain the column’s Grand Total. |
| rowIndex | Int32 | A zero-based integer which identifies the visible index of the row. Pass -1 as a row index to obtain the row’s Grand Total. |
| 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 CreateDrillDownDataSourceAsync 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.
If you use the CreateDrillDownDataSourceAsync method in OLAP, take note of the following limitations:
- For MS SQL Server Analysis Services 2000, the customColumns parameter is ignored. In this instance, the CreateDrillDownDataSourceAsync method returns the granularity attributes.
- A note for MS SQL Server Analysis Services 2005 and 2008. If the customColumns list is null or empty, the CreateDrillDownDataSourceAsync 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.
- 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 CreateDrillDownDataSourceAsync method.
- The CreateDrillDownDataSourceAsync method is not supported for cells corresponding to calculated measures.
- 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 CreateDrillDownDataSourceAsync method throws an exception.
In server and OLAP modes, the CreateDrillDownDataSourceAsync method returns only visible fields if the customColumns parameter is set to null.