How to: Populate documents with data from objects

Applies to: yesVisual Studio noVisual 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

Accesing data in a data object works the same way in document-level projects for Microsoft Office Word as it does in Windows Forms projects. You use the same tools and code to bring the data from an object into your solution, and you can use Windows Forms controls to display the data. In addition, you can display data by using host controls. Host controls are native objects in Microsoft Office Word 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 and VSTO Add-in projects for Excel and Word. For more information, see Features available by Office application and project type.

You must complete three basic steps to populate the document with data from an object:

  • Add a control to the document that you can bind to data.

  • Add a data object to the document.

  • Connect the data object to the BindingSource.

To add a data object

To add a data object, open the Data Sources window and create a data source from an object. For more information, see Add new data sources.

Connect the data object to the BindingSource

In document-level projects, you add controls to your document and bind them to data at design time.

In VSTO Add-in projects, you create controls and bind them at run time.

Document-level projects

To connect the data object to the BindingSource:

  1. Drag the data field you want from the Data Sources window to your document. This automatically creates a control.

  2. In your code, create an instance of the type of the object that you chose for the data source.

  3. Assign the instance to the DataSource property of the BindingSource.

Application-level projects

To connect the data object to the BindingSource:

  1. In your code, create an instance of the type of the object that is associated with the data source.

  2. Create an instance of a BindingSource.

  3. Assign the data source instance to the DataSource property of the BindingSource.

  4. Add the data source as a databinding to the control.

See also