PivotGridControl.CreateSummaryDataSource() Method

Returns a summary data source.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.XtraPivotGrid.v20.2.dll

NuGet Package: DevExpress.Win.PivotGrid

Declaration

C#

public PivotSummaryDataSource CreateSummaryDataSource()

VB.NET

Public Function CreateSummaryDataSource As PivotSummaryDataSource

Returns

Type	Description
PivotSummaryDataSource	A PivotSummaryDataSource object that represents the summary data source.

Remarks

A summary data source is a table whose columns correspond to the fields, while the records correspond to the pivot grid data cells.

In the example below, the CreateSummaryDataSource method is used to create a summary data source which is then assigned to the Grid Control.

C#

DevExpress.XtraPivotGrid.PivotSummaryDataSource ds = pivotGridControl1.CreateSummaryDataSource();
gridControl1.DataSource = ds;

VB.NET

Dim ds As DevExpress.XtraPivotGrid.PivotSummaryDataSource = pivotGridControl1.CreateSummaryDataSource()
GridControl1.DataSource = ds

The image below shows the result:

To identify a column in a summary data source that corresponds to an unbound field, specify its name using the PivotGridFieldBase.UnboundFieldName property. An unbound field is not connected to a datasource field and it should be populated with data manually via the PivotGridControl.CustomUnboundFieldData event.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the CreateSummaryDataSource() 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-implement-rank-function-in-xtrapivotgrid-e1474/CS/Form1.cs#L37

salesPerYear = new Dictionary<int, List<decimal>>();
PivotSummaryDataSource ds = pivotGridControl1.CreateSummaryDataSource();
for(int i = 0; i < ds.RowCount; i++) {

how-to-convert-pivotsummarydatasource-to-datatable-or-any-other-data-source-object-e2679/CS/WindowsApplication53/Form1.cs#L25

    dataGridView1.DataSource = ConvertPivotSummaryDataSourceToDataTable(pivotGridControl1.CreateSummaryDataSource());
}

how-to-mediate-a-pair-of-bridged-chart-and-pivot-grid-with-a-filter-control-e2597/CS/Form1.cs#L116

else if (chartDataSourceType == ChartDataSourceType.PivotSummary)
    realDataSource = pivotGridControl1.CreateSummaryDataSource();

VB.NET

how-to-implement-rank-function-in-xtrapivotgrid-e1474/VB/Form1.vb#L39

salesPerYear = New Dictionary(Of Integer, List(Of Decimal))()
Dim ds As PivotSummaryDataSource = pivotGridControl1.CreateSummaryDataSource()
For i As Integer = 0 To ds.RowCount - 1

how-to-convert-pivotsummarydatasource-to-datatable-or-any-other-data-source-object-e2679/VB/WindowsApplication53/Form1.vb#L23

    dataGridView1.DataSource = ConvertPivotSummaryDataSourceToDataTable(pivotGridControl1.CreateSummaryDataSource())
End Sub

how-to-mediate-a-pair-of-bridged-chart-and-pivot-grid-with-a-filter-control-e2597/VB/Form1.vb#L119

ElseIf chartDataSourceType = ChartPivotInteractionApproaches.ChartDataSourceType.PivotSummary Then
    realDataSource = pivotGridControl1.CreateSummaryDataSource()
End If