GridControl.DataSource Property

Gets or sets the grid control’s data source.

Namespace: DevExpress.XtraGrid

Assembly: DevExpress.XtraGrid.v24.1.dll

NuGet Packages: DevExpress.Win.Grid, DevExpress.Win.Navigation

Declaration

C#

[DefaultValue(null)]
[DXCategory("Data")]
public virtual object DataSource { get; set; }

VB.NET

<DefaultValue(Nothing)>
<DXCategory("Data")>
Public Overridable Property DataSource As Object

Property Value

Type	Default	Description
Object	null	An object representing the grid control’s data source.

Remarks

Refer to the Data Binding and Master-Detail Relationships topics for information on which objects can be assigned to the DataSource property.

After the DataSource property is set to null, the ColumnView.FocusedRowHandle of the GridControl.MainView is set to GridControl.InvalidRowHandle. After a new data source is assigned to the DataSource property, the ColumnView.FocusedRowHandle is set to 0, to refer to the first data record.

The code sample below illustrates how to bind the GridControl to XML data.

C#

xmlDataSet.ReadXml(@".\products.xml");
gridControl1.DataSource = xmlDataSet.Tables["product"];

VB.NET

xmlDataSet.ReadXml(".\products.xml")
gridControl1.DataSource = xmlDataSet.Tables("product")

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#

report-server-how-to-manage-scheduled-jobs-from-a-windows-forms-application/CS/ScheduledTasksAPIClientDemo/MainForm.cs#L42

void FillScheduledJobListBox(IEnumerable<ScheduledJobCatalogItemDto> scheduledJobs) {
    scheduledJobsGrid.DataSource = scheduledJobs;
    scheduledJobsView.BestFitColumns();

winforms-mvvm-expenses-app/CS/MVVMExpenses/Views/Account/AccountsEditFormView.cs#L29

fluent.SetBinding(
    gridControl1, gc => gc.DataSource, x => x.AccountTransactionDetails.Entities);

XDL_how-to-convert-the-criteriaoperator-to-a-lambda-expression-to-use-it-for-iqueryable-e2596/CS/WindowsFormsApplication152/Form1.cs#L37

gridControl1.DataSource = source.ToList();
CreateFilterColumns();

winforms-gridlookupedit-multiple-item-selection/CS/Form1.cs#L109

private void InitGrid() {
    popupGridControl1.DataSource = CreateList(5);
    gridControl2.DataSource = CreateList(5);

winforms-grid-data-annotation-attributes/CS/GridDataAttributes/Form1.cs#L36

case "Company public info":
    gridControl1.DataSource = GridSampleDataList.GetCompanyPublicInfo();
    break;

VB.NET

report-server-how-to-manage-scheduled-jobs-from-a-windows-forms-application/VB/ScheduledTasksAPIClientDemo/MainForm.vb#L42

Private Sub FillScheduledJobListBox(ByVal scheduledJobs As IEnumerable(Of ScheduledJobCatalogItemDto))
    scheduledJobsGrid.DataSource = scheduledJobs
    scheduledJobsView.BestFitColumns()

winforms-mvvm-expenses-app/VB/MVVMExpenses/Views/Account/AccountsEditFormView.vb#L29

fluent.SetObjectDataSourceBinding(accountBindingSource, Function(x) x.Entity, Sub(x) x.Update())
fluent.SetBinding(GridControl1, Function(gc) gc.DataSource, Function(x) x.AccountTransactionDetails.Entities)
CType(GridControl1.MainView, DevExpress.XtraGrid.Views.Grid.GridView).Columns("Account").Visible = False

XDL_how-to-convert-the-criteriaoperator-to-a-lambda-expression-to-use-it-for-iqueryable-e2596/VB/WindowsFormsApplication152/Form1.vb#L36

gridControl1.DataSource = source.ToList()
CreateFilterColumns()

winforms-gridlookupedit-multiple-item-selection/VB/Form1.vb#L106

Private Sub InitGrid()
    popupGridControl1.DataSource = CreateList(5)
    gridControl2.DataSource = CreateList(5)

winforms-grid-data-annotation-attributes/VB/GridDataAttributes/Form1.vb#L33

Case "Company public info"
    gridControl1.DataSource = GridSampleDataList.GetCompanyPublicInfo()
Case "Company private info"