PivotCustomDrawCellBaseEventArgs.CreateDrillDownDataSource() Method

Returns data records used to calculate a summary value for the current cell.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.XtraPivotGrid.v18.2.dll

Declaration

C#

public PivotDrillDownDataSource CreateDrillDownDataSource()

VB.NET

Public Function CreateDrillDownDataSource As PivotDrillDownDataSource

Returns

Type	Description
PivotDrillDownDataSource	A PivotDrillDownDataSource object that contains records used to calculate a summary value for the current cell.

Remarks

The CreateDrillDownDataSource method retrieves data source records used to calculate current cell values.

The Pivot Grid control cells display summary and total summary values. Column and row headers display criteria applied to the underlying data source to obtain a set of data records for summary calculation.

Consider the following sample pivot grid:

In this example, the value in the top-leftmost cell ($1,422.00) is calculated against the ‘Product Sales’ field for a subset of the records which have:

• the value ‘Beverages’ in the ‘Category Name’ field
• the value ‘Chai’ in the ‘Product Name’ field
• 1994 in the ‘Shipped Year’ field

The value at the intersection of the first column and third row ($4,154.96) is calculated for the records which have:

• the ‘Beverages’ value in the ‘Category Name’ field
• 1994 in the ‘Shipped Year’ field.

Note

In OLAP mode, this method equals to the PivotCustomDrawCellBaseEventArgs.CreateOLAPDrillDownDataSource method with the customColumns parameter set to null.

Important

Do not call the CreateDrillDownDataSource method in an asynchronous operation, otherwise an exception occurs. To determine whether the operation is in progress, use the pivot grid’s IThreadSafeAccessible.IsAsyncInProgress property. For more information, refer to the Asynchronous Mode document.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the CreateDrillDownDataSource() method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-change-cell-appearance-depending-on-a-hidden-column-value-e1296/CS/Form1.cs#L27

if(e.DataField == fieldData) {
    PivotDrillDownDataSource ds = e.CreateDrillDownDataSource();
    int hiddenValue = (int)ds.GetValue(0, "hidden");

VB.NET

how-to-change-cell-appearance-depending-on-a-hidden-column-value-e1296/VB/Form1.vb#L29

If e.DataField Is fieldData Then
    Dim ds As PivotDrillDownDataSource = e.CreateDrillDownDataSource()
    Dim hiddenValue As Integer = CInt(Fix(ds.GetValue(0, "hidden")))