How to: Populate worksheets with data from a database

Applies to: Visual Studio Visual Studio for Mac

Note

This article applies to Visual Studio 2017. If you're looking for the latest Visual Studio documentation, see Visual Studio documentation. We recommend upgrading to the latest version of Visual Studio. Download it here

You can access data in document-level Office projects in the same way that you access data in Windows Forms projects. You use the same tools and code to bring the data into your solution, and you can even use Windows Forms controls to display the data. In addition, you can take advantage of controls called host controls, which are native objects in Microsoft Office Excel that have been enhanced with events and data-binding capability. For more information, see Host items and host controls overview.

Applies to: The information in this topic applies to document-level projects for Excel. For more information, see Features available by Office application and project type.

The following example shows how to add data-bound controls in document-level projects using a designer. For an example of how to add data-bound controls in application-level projects at run time, see Walkthrough: Complex data binding in VSTO Add-in project.

Add a data-bound control to a worksheet at design time

To populate a worksheet with data from a database

1. Open an Excel document-level project in Visual Studio, with the worksheet open in the designer.

2. Open the Data Sources window and create a data source for your project. For more information, see Add new connections.

3. Drag the field or table you want from the Data Sources window to your worksheet.

One of the following controls is created on the worksheet:

• If you drag a field, a NamedRange control is created on the worksheet. For more information, see NamedRange control.

• If you drag a table, a ListObject control is created on the worksheet. For more information, see ListObject control.

You can add a different control by selecting the table or field in the Data Sources window and then choosing a different control from the drop-down list.

Objects in the project

In addition to the control, the following data-related objects are automatically added to your project:

• A typed dataset that encapsulates the data tables that you connected to in the database. For more information, see Dataset tools in Visual Studio.

• A BindingSource that connects the control to the typed dataset. For more information, see BindingSource component overview.

• A TableAdapter that connects the typed dataset to the database. For more information, see TableAdapter overview.

• A TableAdapterManager, which is used to coordinate table adapters in the dataset to enable hierarchical updates. For more information, see Hierarchical update and TableAdapterManager reference.

When you run the project, the control displays the first record in the data source. You can use the BindingSource to enable users to scroll through the records.

To scroll through the records

• Use BindingSource methods such as MoveNext and MovePrevious.

For information about how to send updates to the typed dataset and the database, see How to: Update a data source with data from a host control.

See also

• Bind data to controls in Office solutions
• Add new data sources
• Bind Windows Forms controls to data in Visual Studio
• How to: Populate documents with data from objects
• How to: Populate documents with data from a database
• How to: Populate documents with data from services
• How to: Update a data source with data from a host control