PivotGridControl.CreateDrillDownDataSource(Int32, Int32, Int32, List<String>) Method

Returns data records used to calculate a summary value for the specified cell. Allows you to specify the columns and limit the number of records to return.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.XtraPivotGrid.v24.1.dll

NuGet Package: DevExpress.Win.PivotGrid

Declaration

C#

public PivotDrillDownDataSource CreateDrillDownDataSource(
    int columnIndex,
    int rowIndex,
    int maxRowCount,
    List<string> customColumns
)

VB.NET

Public Function CreateDrillDownDataSource(
    columnIndex As Integer,
    rowIndex As Integer,
    maxRowCount As Integer,
    customColumns As List(Of String)
) As PivotDrillDownDataSource

Parameters

Name	Type	Description
columnIndex	Int32	A zero-based visible column’s index of the column. Set it to -1 to obtain the column’s Grand Total.
rowIndex	Int32	A zero-based visible row’s index. Set it to -1 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.

Returns

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

Remarks

Important

The customColumns parameter is in effect in Server and OLAP modes only; otherwise, it is ignored.

If you use the CreateDrillDownDataSource method in OLAP mode, take note of the following limitations:

OLAP Server	Note
MS SQL Server Analysis Services 2000	The customColumns parameter is ignored and the CreateDrillDownDataSource method returns the granularity attributes.
MS SQL Server Analysis Services 2005 and 2008	If the customColumns list is null or empty, the CreateDrillDownDataSource method returns the columns related to the current column, row and data PivotGrid fields. The method also returns filter fields, if any.
Any OLAP Server	If returned records contain a column used as a filter in Pivot Grid, the returned data are filtered.
Any OLAP Server	The CreateDrillDownDataSource is not applicable for fields which are calculated measures.
MS SQL Server Analysis Services - all versions	Multiple filter items selected in a Filter field results in an exception.

In server and OLAP modes, the CreateDrillDownDataSource method returns only visible fields. To get hidden field values, use the method’s overloads with the customColumns parameter which allow you to specify the columns to return.

Note

For an example of use refer to the CreateDrillDownDataSource(Int32, Int32, Int32, List<String>) topic.

Example

This example demonstrates how to obtain the records from the control’s underlying data source for a particular cell. Double-click a cell to invoke a form that contains a grid to show the underlying data.

Note

The complete sample project How to: Display Underlying (Drill-Down) Records is available in the DevExpress Examples repository.

The primary data source is the Northwind database contained in the SQL Server data file NW.mdf. The application can use the BindingSource component or the LinqServerModeDataSource instance to retrieve the data from the database. A LinqServerModeDataSource data source is a queryable data source, and it forces the PivotGrid to operate in server mode. Click the Server Mode toggle switch control to switch from one data source to another.

When you double-click the PivotGrid cell, the PivotGridControl.CellDoubleClick event occurs. The following CreateDrillDownDataSource method overrides are called to obtain the list of records associated with the selected cell:

• If Server Mode is not enabled, the e.CreateDrillDownDataSource(Int32) method returns a data source that contains the columns retrieved from the original data source as well as the columns which the PivotGrid creates.
• If Server Mode is enabled, the e.CreateDrillDownDataSource(int maxRowCount, List<string> customColumns method returns a data source that contains the columns shown in the PivotGridControl and the columns explicitly specified in the method parameter.

You can also click the Get Grand Total Data button to call the PivotGridControl.CreateDrillDownDataSource method and display all data records that the PivotGridControl uses to show the summarized data.

C#

using DevExpress.XtraEditors;
using DevExpress.XtraGrid;
using DevExpress.XtraGrid.Views.Grid;
using DevExpress.XtraPivotGrid;
using System;
using System.Collections.Generic;
using System.Drawing;
using System.Windows.Forms;

namespace DrillDownDataSourceExample
{
    public partial class Form1 : DevExpress.XtraEditors.XtraForm
    {
        bool serverMode = false;
        public Form1()
        {
            InitializeComponent();
            pivotGridControl1.CellDoubleClick += PivotGridControl1_CellDoubleClick;
            // This line of code is generated by Data Source Configuration Wizard
            linqServerModeSource1.QueryableSource = new DrillDownDataSourceExample.DataClasses1DataContext().Invoices;
        }

        private void PivotGridControl1_CellDoubleClick(object sender, DevExpress.XtraPivotGrid.PivotCellEventArgs e)
        {
            PivotDrillDownDataSource drillDownDataSource;
            if (serverMode)
               drillDownDataSource = e.CreateDrillDownDataSource(25, new List<string> { "ShipName" });
            else
                drillDownDataSource = e.CreateDrillDownDataSource(25);
            XtraForm dataform = CreateDrillDownForm(drillDownDataSource);
            dataform.ShowDialog();
            dataform.Dispose();
        }

        private void Form1_Load(object sender, EventArgs e)
        {
            // TODO: This line of code loads data into the 'nWDataSet.Invoices' table. You can move, or remove it, as needed.
            this.invoicesTableAdapter.Fill(this.nWDataSet.Invoices);
            SetPivotGridDataSource();
        }

        private XtraForm CreateDrillDownForm(PivotDrillDownDataSource dataSource) {
            XtraForm form = new XtraForm();
            GridControl grid = new GridControl();
            grid.Parent = form;
            grid.Dock = DockStyle.Fill;
            grid.DataSource = dataSource;
            grid.DataSource =
            form.Bounds = new Rectangle(100, 100, 800, 400);
            GridView gridView1 = new GridView();
            grid.MainView = gridView1;
            gridView1.Columns["OrderDate"].DisplayFormat.FormatType = DevExpress.Utils.FormatType.DateTime;
            form.Text = string.Format("Underlying Data - {0} Records", dataSource.RowCount);
            return form;
        }

        private void toggleSwitch1_Toggled(object sender, EventArgs e)
        {
            serverMode = ((ToggleSwitch)sender).IsOn;
            SetPivotGridDataSource();
        }

        private void SetPivotGridDataSource()
        {
            if (serverMode)
                pivotGridControl1.DataSource = linqServerModeSource1;
            else
                pivotGridControl1.DataSource = invoicesBindingSource;
        }

        private void btnGrandTotal_Click(object sender, EventArgs e)
        {
            PivotDrillDownDataSource drillDownDataSource = pivotGridControl1.CreateDrillDownDataSource();
            Form dataform = CreateDrillDownForm(drillDownDataSource);
            dataform.ShowDialog();
            dataform.Dispose();
        }
    }
}

VB.NET

Imports DevExpress.XtraEditors
Imports DevExpress.XtraGrid
Imports DevExpress.XtraGrid.Views.Grid
Imports DevExpress.XtraPivotGrid
Imports System
Imports System.Collections.Generic
Imports System.Drawing
Imports System.Windows.Forms

Namespace DrillDownDataSourceExample
   Partial Public Class Form1
      Inherits DevExpress.XtraEditors.XtraForm

      Private serverMode As Boolean = False
      Public Sub New()
         InitializeComponent()
         AddHandler pivotGridControl1.CellDoubleClick, AddressOf PivotGridControl1_CellDoubleClick
         ' This line of code is generated by Data Source Configuration Wizard
         linqServerModeSource1.QueryableSource = (New DrillDownDataSourceExample.DataClasses1DataContext()).Invoices
      End Sub

      Private Sub PivotGridControl1_CellDoubleClick(ByVal sender As Object, ByVal e As DevExpress.XtraPivotGrid.PivotCellEventArgs)
         Dim drillDownDataSource As PivotDrillDownDataSource
         If serverMode Then
            drillDownDataSource = e.CreateDrillDownDataSource(25, New List(Of String) From {"ShipName"})
         Else
            drillDownDataSource = e.CreateDrillDownDataSource(25)
         End If
         Dim dataform As XtraForm = CreateDrillDownForm(drillDownDataSource)
         dataform.ShowDialog()
         dataform.Dispose()
      End Sub

      Private Sub Form1_Load(ByVal sender As Object, ByVal e As EventArgs) Handles Me.Load
         ' TODO: This line of code loads data into the 'nWDataSet.Invoices' table. You can move, or remove it, as needed.
         Me.invoicesTableAdapter.Fill(Me.nWDataSet.Invoices)
         SetPivotGridDataSource()
      End Sub

      Private Function CreateDrillDownForm(ByVal dataSource As PivotDrillDownDataSource) As XtraForm
         Dim form As New XtraForm()
         Dim grid As New GridControl()
         grid.Parent = form
         grid.Dock = DockStyle.Fill
         grid.DataSource = dataSource
         form.Bounds = New Rectangle(100, 100, 800, 400)
         grid.DataSource = form.Bounds
         Dim gridView1 As New GridView()
         grid.MainView = gridView1
         gridView1.Columns("OrderDate").DisplayFormat.FormatType = DevExpress.Utils.FormatType.DateTime
         form.Text = String.Format("Underlying Data - {0} Records", dataSource.RowCount)
         Return form
      End Function

      Private Sub toggleSwitch1_Toggled(ByVal sender As Object, ByVal e As EventArgs) Handles toggleSwitch1.Toggled
         serverMode = DirectCast(sender, ToggleSwitch).IsOn
         SetPivotGridDataSource()
      End Sub

      Private Sub SetPivotGridDataSource()
         If serverMode Then
            pivotGridControl1.DataSource = linqServerModeSource1
         Else
            pivotGridControl1.DataSource = invoicesBindingSource
         End If
      End Sub

      Private Sub btnGrandTotal_Click(ByVal sender As Object, ByVal e As EventArgs) Handles btnGrandTotal.Click
         Dim drillDownDataSource As PivotDrillDownDataSource = pivotGridControl1.CreateDrillDownDataSource()
         Dim dataform As Form = CreateDrillDownForm(drillDownDataSource)
         dataform.ShowDialog()
         dataform.Dispose()
      End Sub
   End Class
End Namespace