PivotGridControl.DataSource Property

Gets or sets the object used as the data source for the current control.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.XtraPivotGrid.v24.1.dll

NuGet Package: DevExpress.Win.PivotGrid

Declaration

C#

[DefaultValue(null)]
public object DataSource { get; set; }

VB.NET

<DefaultValue(Nothing)>
Public Property DataSource As Object

Property Value

Type	Default	Description
Object	null	The object used as the data source.

Remarks

Objects such as a DataTable, a DataView, a IList, a IListSource and IBindingList can be used as data sources.

If some of the data source field values are custom objects (not numeric or string values), use the PivotGridOptionsData.CustomObjectConverter property to specify a serializer to be used to process them. Otherwise, you will be unable to save/restore the Pivot Grid Control layout and data to/from a file or stream.

Assigning a new value to the PivotGridControl.DataMember or DataSource property raises the PivotGridControl.DataSourceChanged event, and causes a Pivot Grid Control update. The Pivot Grid Control is not updated automatically when the current data source is modified. To force the Pivot Grid Control update, use the PivotGridControl.RefreshData method.

Note

The PivotGridControl.DataSourceChanged event is raised and the Pivot Grid Control is updated when the data source implementing the IBindingList interface raises the ListChanged event of the PropertyDescriptorAdded, PropertyDescriptorDeleted, PropertyDescriptorChanged or Reset type.

To retrieve data from a data source asynchronously, assign it using the PivotGridControl.SetDataSourceAsync method instead of the DataSource property.

To learn more on data binding, see Binding to Data.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the DataSource property.

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#

winforms-pivot-grid-hide-specific-columns-and-rows/CS/Form1.cs#L15

PivotHelper.FillPivot(pivotGridControl1);
pivotGridControl1.DataSource = PivotHelper.GetDataTable();
pivotGridControl1.BestFit();

winforms-pivot-split-field-value-cells/CS/Form1.cs#L17

PivotHelper.FillPivot(pivotGridControl1);
pivotGridControl1.DataSource = PivotHelper.GetDataTable();
pivotGridControl1.BestFit();

winforms-pivot-grid-add-custom-field-values-rows-column-not-present-in-datasource/CS/CustomDatesPivot/Form1.cs#L45

    Table = CreatePivotTable(100);
    pivotGridControl1.DataSource = Table;
}

winforms-pivotgrid-how-to-display-underlying-data/CS/DrillDownDataSourceExample/Form1.cs#L66

if (serverMode)
    pivotGridControl1.DataSource = linqServerModeSource1;
else

winforms-pivotgrid-linq-to-sql-server-mode/CS/LinqToSqlServerModeExample/Form1.cs#L42

if (serverMode)
    pivotGridControl1.DataSource = linqServerModeSource1;
else

VB.NET

winforms-pivot-grid-hide-specific-columns-and-rows/VB/Form1.vb#L16

PivotHelper.FillPivot(pivotGridControl1)
pivotGridControl1.DataSource = PivotHelper.GetDataTable()
pivotGridControl1.BestFit()

winforms-pivot-split-field-value-cells/VB/Form1.vb#L18

PivotHelper.FillPivot(pivotGridControl1)
pivotGridControl1.DataSource = PivotHelper.GetDataTable()
pivotGridControl1.BestFit()

winforms-pivot-grid-add-custom-field-values-rows-column-not-present-in-datasource/VB/CustomDatesPivot/Form1.vb#L41

    Table = CreatePivotTable(100)
    pivotGridControl1.DataSource = Table
End Sub

winforms-pivotgrid-how-to-display-underlying-data/VB/DrillDownDataSourceExample/Form1.vb#L62

If serverMode Then
    pivotGridControl1.DataSource = linqServerModeSource1
Else

winforms-pivotgrid-linq-to-sql-server-mode/VB/LinqToSqlServerModeExample/Form1.vb#L34

If serverMode Then
    pivotGridControl1.DataSource = linqServerModeSource1
Else