Walkthrough: Complex Data Binding in an Application-Level Project

Article
01/10/2013

You can bind data to host controls and Windows Forms controls in application-level projects. This walkthrough demonstrates how to add controls to a Microsoft Office Excel worksheet and bind the controls to data at run time.

Applies to: The information in this topic applies to application-level projects for Excel 2013 and Excel 2010. For more information, see Features Available by Office Application and Project Type.

This walkthrough illustrates the following tasks:

Adding a ListObject control to a worksheet at run time.
Creating a BindingSource that connects the control to an instance of a dataset.

Note

Your computer might show different names or locations for some of the Visual Studio user interface elements in the following instructions. The Visual Studio edition that you have and the settings that you use determine these elements. For more information, see Visual Studio Settings.

Prerequisites

You need the following components to complete this walkthrough:

An edition of Visual Studio 2012 that includes the Microsoft Office developer tools. For more information, see Configuring a Computer to Develop Office Solutions.
Excel 2013 or Excel 2010.
Access to a running instance of SQL Server 2005 or SQL Server 2005 Express that has the AdventureWorksLT sample database attached to it. You can download the AdventureWorksLT database from the CodePlex Web site. For more information about attaching a database, see the following topics:
- To attach a database by using SQL Server Management Studio or SQL Server Management Studio Express, see How to: Attach a Database (SQL Server Management Studio).
- To attach a database by using the command line, see How to: Attach a Database File to SQL Server Express.

Creating a New Project

The first step is to create an Excel add-in project.

To create a new project

Create an Excel add-in project with the name Populating Worksheets from a Database, using either Visual Basic or C#.

For more information, see How to: Create Office Projects in Visual Studio.

Visual Studio opens the ThisAddIn.vb or ThisAddIn.cs file and adds the Populating Worksheets from a Database project to Solution Explorer.

Creating a Data Source

Use the Data Sources window to add a typed dataset to your project.

To add a typed dataset to the project

If the Data Sources window is not visible, display it by, on the menu bar, choosing View, Other Windows, Data Sources.
Choose Add New Data Source to start the Data Source Configuration Wizard.
Click Database, and then click Next.
If you have an existing connection to the AdventureWorksLT database, choose this connection and click Next.

Otherwise, click New Connection, and use the Add Connection dialog box to create the new connection. For more information, see How to: Connect to Data in a Database.
In the Save the Connection String to the Application Configuration File page, click Next.
In the Choose Your Database Objects page, expand Tables and select Address (SalesLT).
Click Finish.

The AdventureWorksLTDataSet.xsd file is added to Solution Explorer. This file defines the following items:
- A typed dataset named AdventureWorksLTDataSet. This dataset represents the contents of the Address (SalesLT) table in the AdventureWorksLT database.
- A TableAdapter named AddressTableAdapter. This TableAdapter can be used to read and write data in the AdventureWorksLTDataSet. For more information, see TableAdapter Overview.
You will use both of these objects later in this walkthrough.

Creating Controls and Binding Controls to Data

For this walkthrough, the ListObject control displays all the data in the table you selected as soon as the user opens the workbook. The list object uses a BindingSource to connect the control to the database.

For more information about binding controls to data, see Binding Data to Controls in Office Solutions.

To add the list object, dataset, and table adapter

In the ThisAddIn class, declare the following controls to display the Address table of the AdventureWorksLTDataSet dataset.

Private addressListObject As Microsoft.Office.Tools.Excel.ListObject
Private adventureWorksDataSet As AdventureWorksLTDataSet
Private addressTableAdapter As AdventureWorksLTDataSetTableAdapters.AddressTableAdapter
Private addressBindingSource As System.Windows.Forms.BindingSource

private Microsoft.Office.Tools.Excel.ListObject addressListObject;
private AdventureWorksLTDataSet adventureWorksDataSet;
private AdventureWorksLTDataSetTableAdapters.AddressTableAdapter addressTableAdapter;
private System.Windows.Forms.BindingSource addressBindingSource;

In the ThisAddIn_Startup method, add the following code to initialize the dataset and fill the dataset with information from the AdventureWorksLTDataSet dataset.

Me.addressTableAdapter = New AdventureWorksLTDataSetTableAdapters.AddressTableAdapter()
Me.adventureWorksDataSet = New AdventureWorksLTDataSet()
Me.addressTableAdapter.Fill(Me.adventureWorksDataSet.Address)
Me.addressBindingSource = New System.Windows.Forms.BindingSource()

this.addressTableAdapter = new AdventureWorksLTDataSetTableAdapters.AddressTableAdapter();
this.adventureWorksDataSet = new AdventureWorksLTDataSet();
this.addressTableAdapter.Fill(this.adventureWorksDataSet.Address);
this.addressBindingSource = new System.Windows.Forms.BindingSource();

Add the following code to the ThisAddIn_Startup method. This generates a host item that extends the worksheet. For more information, see Extending Word Documents and Excel Workbooks in Application-Level Add-ins at Run Time.

Dim worksheet As Excel.Worksheet = DirectCast(Me.Application.ActiveWorkbook.Worksheets(1), Excel.Worksheet)

        ' Create a workhseet host item. 
        Dim extendedWorksheet As Worksheet = Globals.Factory.GetVstoObject(worksheet)

            Excel.Worksheet worksheet = (Excel.Worksheet)this.Application.ActiveWorkbook.Worksheets[1];
            // Create a workhseet host item.
            Worksheet extendedWorksheet = Globals.Factory.GetVstoObject(worksheet);

Create a range and add the ListObject control.

Dim cell As Excel.Range = extendedWorksheet.Range("$A$1:$G$5", System.Type.Missing)
Me.addressListObject = extendedWorksheet.Controls.AddListObject(cell, "list1")

Excel.Range cell = extendedWorksheet.Range["$A$1:$G$5"];
this.addressListObject = extendedWorksheet.Controls.AddListObject(cell, "list1");

Bind the list object to AdventureWorksLTDataSet by using the BindingSource. Pass in the names of the columns you want to bind to the list object.

Me.addressBindingSource.DataSource = Me.adventureWorksDataSet.Address
Me.addressListObject.AutoSetDataBoundColumnHeaders = True 
Me.addressListObject.SetDataBinding( _
    Me.addressBindingSource, "", "AddressID", "AddressLine1", _
    "AddressLine2", "City", "StateProvince", "CountryRegion", "PostalCode")

this.addressBindingSource.DataSource = this.adventureWorksDataSet.Address;
this.addressListObject.AutoSetDataBoundColumnHeaders = true;
this.addressListObject.SetDataBinding(
    this.addressBindingSource, "", "AddressID", "AddressLine1", 
    "AddressLine2", "City", "StateProvince", "CountryRegion", "PostalCode");

Testing the Add-In

When you open Excel, the ListObject control displays the data from the Address table of the AdventureWorksLTDataSet dataset.

To test the add-in

Press F5.

A ListObject control named addressListObject is created in the worksheet. At the same time, a dataset object named adventureWorksLTDataSet and a BindingSource named addressBindingSource are added to the project. The ListObject is bound to the BindingSource, which in turn is bound to the dataset object.

Share via

Walkthrough: Complex Data Binding in an Application-Level Project

Prerequisites

Creating a New Project

To create a new project

Creating a Data Source

To add a typed dataset to the project

Creating Controls and Binding Controls to Data

To add the list object, dataset, and table adapter

Testing the Add-In

To test the add-in

See Also

Tasks

Reference

Concepts

Other Resources

Additional resources