PivotGridControl.DataSource Property

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

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.XtraPivotGrid.v19.1.dll

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#

keeping-a-checked-filter-item-displayed-when-records-are-removed-from-the-data-source-e2684/CS/XtraPivotGrid_S18746/Form1.cs#L16

private void Form1_Load(object sender, EventArgs e) {
    pivotGridControl1.DataSource = PivotHelper.GetFullDataTable();
    pivotGridControl1.BestFit();

how-to-implement-a-custom-object-serializer-e2879/CS/XtraPivotGrid_CustomObjectConverter/Form1.cs#L12

InitializeComponent();
pivotGridControl1.DataSource = DataHelper.GetData();
pivotGridControl1.OptionsData.CustomObjectConverter = new CustomObjectConverter();

how-to-locate-field-value-cells-matching-a-particular-condition-e2772/CS/Form1.cs#L15

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

how-to-prevent-pivotgrid-from-getting-properties-values-e945/CS/Form1.cs#L17

fakeDataSource.Add(new DataObject());
pivotGridControl1.DataSource = new DataSourceWrapper(ReportType.Report1, fakeDataSource);
pivotGridControl1.RetrieveFields();

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

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

VB.NET

keeping-a-checked-filter-item-displayed-when-records-are-removed-from-the-data-source-e2684/VB/XtraPivotGrid_S18746/Form1.vb#L18

Private Sub Form1_Load(ByVal sender As Object, ByVal e As EventArgs) Handles MyBase.Load
    pivotGridControl1.DataSource = PivotHelper.GetFullDataTable()
    pivotGridControl1.BestFit()

how-to-implement-a-custom-object-serializer-e2879/VB/XtraPivotGrid_CustomObjectConverter/Form1.vb#L14

InitializeComponent()
pivotGridControl1.DataSource = DataHelper.GetData()
pivotGridControl1.OptionsData.CustomObjectConverter = _

how-to-prevent-pivotgrid-from-getting-properties-values-e945/VB/Form1.vb#L19

fakeDataSource.Add(New DataObject())
pivotGridControl1.DataSource = New DataSourceWrapper(ReportType.Report1, fakeDataSource)
pivotGridControl1.RetrieveFields()

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

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

how-to-add-custom-field-values-rows-columns-that-are-not-present-in-a-datasource-e4493/VB/CustomDatesPivot/Form1.vb#L41

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