Walkthrough: Binding Data to Controls on a Word Actions Pane

Walkthrough: Binding Data to Contro...

Switch on low bandwidth view

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2005/.NET Framework 2.0

Other versions are also available for the following:

Visual Studio Tools for the Microsoft Office System

Walkthrough: Binding Data to Controls on a Word Actions Pane

Note	Required applications
The features in this topic are available only if you have the required applications installed. For more information, see Features Available by Product Combination.	One of these development environments: VSTO 2005 -or- Visual Studio Team System Microsoft Office 2003

Note

Required applications

The features in this topic are available only if you have the required applications installed.

For more information, see Features Available by Product Combination.

One of these development environments:

VSTO 2005

-or-

Visual Studio Team System
Microsoft Office 2003

This walkthrough demonstrates data binding to controls on an actions pane in Microsoft Office Word 2003. The controls will demonstrate a master/detail relation between tables in a SQL Server database.

During this walkthrough, you will learn how to:

Create an actions pane control for the actions pane.
Add Windows Forms controls that are bound to data to an actions pane control.
Use a master/detail relationship when displaying data in the controls.
Show the actions pane when the application opens.
Test your project.

Note
The dialog boxes and menu commands you see might differ from those described in Help depending on your active settings or edition. To change your settings, choose Import and Export Settings on the Tools menu. For more information, see Visual Studio Settings.

Prerequisites

To complete this walkthrough, you will need:

Microsoft Visual Studio 2005 Tools for the Microsoft Office System.
Microsoft Office Word 2003.
Access to a server with the Northwind SQL Server sample database.
Permissions to read from and write to the SQL Server database.

Creating the Project

In this step, you will create a Word Document project.

To create a new project

Create a Word Document project with the name My Word Actions Pane. Make sure that Create a new document is selected. For more information, see How to: Create Visual Studio Tools for Office Projects.

Visual Studio opens the new Word document in the designer and adds the My Word Actions Pane project to Solution Explorer.

Adding Controls to the Actions Pane

For this walkthrough, you need an actions pane control that contains data-bound Windows Forms controls. Add a data source to the project, and then drag controls from the Data Sources window to the actions pane control.

To add an actions pane control

Select the My Word Actions Pane project in Solution Explorer.
On the Project menu, select Add New Item.
In the Add New Item dialog box, select Actions Pane Control, name it ActionsControl, and then click Add.

To add a new data source to the project

If the Data Sources window is not visible, click Show Data Sources on the Data menu.

Note

If Show Data Sources is not available, click inside the Word document and then check again.
Click Add New Data Source to start the Data Source Configuration Wizard.
Select Database and then click Next.
Select a data connection to the Northwind sample SQL Server database, or add a new connection using the New Connection button.
Click Next.
Clear the option to save the connection if it is selected, and then click Next.
Expand the Tables node in the Database objects window.
Select the check box next to the Suppliers and Products tables.
Click Finish.

Note
If Show Data Sources is not available, click inside the Word document and then check again.

The wizard adds the Suppliers table and Products table to the Data Sources window. It also adds a typed dataset to your project that is visible in Solution Explorer.

To add data-bound Windows Forms controls to an actions pane control

In the Data Sources window, expand the Suppliers table.
Click the drop-down arrow on the Company Name node, and select ComboBox.
Drag CompanyName from the Data Sources window to the actions pane control.

A ComboBox control is created on the actions pane control. At the same time, a BindingSource named SuppliersBindingSource, a table adapter, and a DataSet are added to the project in the component tray.
Select the SuppliersBindingNavigator in the Component tray and press DELETE. You will not use the SuppliersBindingNavigator in this walkthrough.

Note

Deleting the SuppliersBindingNavigator does not remove all of the code that was generated for it. You can remove this code.
Move the combo box so that it is under the label and change the Size property to 171, 21.
In the Data Sources window, expand the Products table that is a child of the Suppliers table.
Click the drop-down arrow on the ProductName node, and select ListBox.
Drag ProductName to the actions pane control.

A ListBox control is created on the actions pane control. At the same time, a BindingSource named ProductBindingSource and a table adapter are added to the project in the component tray.
Move the list box so that it is under the label and change the Size property to 171,95.
Drag a Button from the Toolbox onto the actions pane control and place it below the list box.
Right-click the Button, click Properties in the shortcut menu, and change the following properties:

Property Value

Name

Insert

Text

Insert
Resize the user control to fit the controls.

Note
Deleting the `SuppliersBindingNavigator` does not remove all of the code that was generated for it. You can remove this code.

Property	Value
Name	Insert
Text	Insert

Setting Up the Data Source

In this section, you will add code to the Load event of the actions pane control to fill the control with data from the DataTable. You will then set the DataSource and DataMember properties for each control.

To load the control with data

In the Load event handler of the ActionsControl class, add the following code:

Visual Basic

Private Sub ActionsControl_Load(ByVal sender As Object, ByVal e As System.EventArgs) _
    Handles Me.Load

    Me.SuppliersTableAdapter.Fill(Me.NorthwindDataSet.Suppliers)
    Me.ProductsTableAdapter.Fill(Me.NorthwindDataSet.Products)
End Sub

private void ActionsControl_Load(object sender, EventArgs e)
{
    this.suppliersTableAdapter.Fill(this.northwindDataSet.Suppliers);
    this.productsTableAdapter.Fill(this.northwindDataSet.Products);
}

In C#, you must attach the event handler to the Load event. You can place this code in the ActionsControl constructor, after the call to InitializeComponent. For more information about creating event handlers, see How to: Create Event Handlers in Visual Studio Tools for Office.
C#
```
this.Load += new EventHandler(ActionsControl_Load);
```

To set data binding properties of the controls

Select the CompanyNameComboBox control.
In the Properties window, click the button to the right of the DataSource property, and select suppliersBindingSource.
In the Properties window, click the button to the right of the DisplayMember property, and select CompanyName.
In the Properties window, expand the DataBindings property, click the button to the right of the Text property, and select None.
Select the ProductNameListBox control.
In the Properties window, click the button to the right of the DataSource property, and select productsBindingSource.
In the Properties window, click the button to the right of the DisplayMember property, and select ProductName.
In the Properties window, expand the DataBindings property, click the button to the right of the SelectedValue property, and select None.

Adding a Method to Insert Data into a Table

In this step, you will read the data from the bound controls and populate a table in your Word document. First, you will create a procedure for formatting the headings in the table, and then you will add the AddData method to create and format a Word table.

To format the table headings

In the ActionsControl class, create a method to format the headings of the table. Add code as shown in the following example:

Visual Basic

Shared Sub SetHeadings(ByVal tblCell As Word.Cell, ByVal text As String)

    With tblCell.Range
        .Text = text
        .Font.Bold = True
        .ParagraphFormat.Alignment = Word.WdParagraphAlignment.wdAlignParagraphCenter
    End With
End Sub

static void SetHeadings(Microsoft.Office.Interop.Word.Cell tblCell, string text)
{
    tblCell.Range.Text = text;
    tblCell.Range.Font.Bold = 1;
    tblCell.Range.ParagraphFormat.Alignment = 
        Microsoft.Office.Interop.Word.WdParagraphAlignment.wdAlignParagraphCenter;
}

To create the table

In the ActionsControl class, write a method that will create a table if one does not already exist, and add data from the actions pane to the table. Add code as shown in the following example.

Visual Basic

Private Sub AddData(ByVal row As DataRow, ByVal companyName As String)

    ' Create a table if it doesn't already exist.
    If Globals.ThisDocument.Tables.Count = 0 Then

        Try
            ' Create a table. 
            Dim tbl As Word.Table = Globals.ThisDocument.Tables.Add( _
                Globals.ThisDocument.Application.Selection.Range, 1, 4)

            ' Insert headings.
            SetHeadings(tbl.Cell(1, 1), "Company Name")
            SetHeadings(tbl.Cell(1, 2), "Product Name")
            SetHeadings(tbl.Cell(1, 3), "Quantity")
            SetHeadings(tbl.Cell(1, 4), "Unit Price")

        Catch ex As Exception
            MessageBox.Show("Problem creating Products table: " & ex.Message, _
                "Actions Pane", MessageBoxButtons.OK, MessageBoxIcon.Error)
        End Try
    End If

    ' Add data from data row to the table.
    Dim selection As Word.Selection = Globals.ThisDocument.Application.Selection

    If selection.Tables.Count > 0 Then

        Dim newRow As Word.Row = Globals.ThisDocument.Tables(1).Rows.Add()
        With newRow
            .Range.Font.Bold = False
            .Range.ParagraphFormat.Alignment = Word.WdParagraphAlignment.wdAlignParagraphLeft
            .Cells(4).Range.ParagraphFormat.Alignment = Word.WdParagraphAlignment.wdAlignParagraphRight
            .Cells(1).Range.Text = companyName
            .Cells(2).Range.Text = row.Item("ProductName").ToString
            .Cells(3).Range.Text = row.Item("QuantityPerUnit").ToString
            .Cells(4).Range.Text = Math.Round(row.Item("UnitPrice"), 2)
        End With

    Else
        MessageBox.Show("Cursor must be within a table.", _
            "Actions Pane", MessageBoxButtons.OK, MessageBoxIcon.Error)
    End If
End Sub

private void AddData(DataRow row, string companyName)
{
    object missing = System.Type.Missing;

    // Create a table if it doesn't already exist.
    if (Globals.ThisDocument.Tables.Count == 0)
    {
        try
        {
            // Create a table.
            Microsoft.Office.Interop.Word.Table tbl = Globals.ThisDocument.Tables.Add
                (Globals.ThisDocument.Application.Selection.Range, 1, 4, ref missing, ref missing);

            // Insert headings.
            SetHeadings(tbl.Cell(1, 1), "Company Name");
            SetHeadings(tbl.Cell(1, 2), "Product Name");
            SetHeadings(tbl.Cell(1, 3), "Quantity");
            SetHeadings(tbl.Cell(1, 4), "Unit Price");
        }
        catch (Exception ex)
        {
            MessageBox.Show("Problem creating Products table: " + ex.Message, 
                "Actions Pane", MessageBoxButtons.OK, MessageBoxIcon.Error);
        }
    }

    // Add data from data row to the table.
    Microsoft.Office.Interop.Word.Selection selection = Globals.ThisDocument.Application.Selection;

    if (selection.Tables.Count > 0)
    {
        Microsoft.Office.Interop.Word.Row newRow = Globals.ThisDocument.Tables[1].Rows.Add(ref missing);

        newRow.Range.Font.Bold = 0;

        newRow.Range.ParagraphFormat.Alignment = 
            Microsoft.Office.Interop.Word.WdParagraphAlignment.wdAlignParagraphLeft;

        newRow.Cells[4].Range.ParagraphFormat.Alignment =
            Microsoft.Office.Interop.Word.WdParagraphAlignment.wdAlignParagraphRight;

        newRow.Cells[1].Range.Text = companyName;
        newRow.Cells[2].Range.Text = row["ProductName"].ToString();
        newRow.Cells[3].Range.Text = row["QuantityPerUnit"].ToString();
        newRow.Cells[4].Range.Text = Math.Round(Convert.ToDouble(row["UnitPrice"])).ToString("#,##0.00");
    }
    else
    {
        MessageBox.Show("Cursor must be within a table.", 
            "Actions Pane", MessageBoxButtons.OK, MessageBoxIcon.Error);
    }
}

To insert text into a Word table

In the Click event handler of the Insert button, add code as shown in the following example:

Note
For information on creating event handlers, see How to: Create Event Handlers in Visual Studio Tools for Office.

Visual Basic

Private Sub Insert_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles Insert.Click

    Dim tbl As DataTable = NorthwindDataSet.Products
    Dim rows() As DataRow

    ' Check if a product is selected.
    If Not Me.ProductNameListBox.SelectedIndex < 0 Then

        Dim product As String = Me.ProductNameListBox.SelectedItem.Row.Item("ProductName")
        Dim company As String = Me.CompanyNameComboBox.Text

        ' Return the data row from the selected Product in the list box.
        rows = tbl.Select("ProductName = '" & product.Replace("'", "''") & "'")

        AddData(rows(0), company)

    Else
        MessageBox.Show("Please select a product.", "Actions Pane", MessageBoxButtons.OK)
    End If
End Sub

private void Insert_Click(object sender, System.EventArgs e)
{
    DataTable tbl = northwindDataSet.Products;
    DataRow[] rows;

    // Check if a product is selected.
    if (this.productNameListBox.SelectedIndex >= 0)
    {
        DataRowView productRow =(System.Data.DataRowView)this.productNameListBox.SelectedItem;

        string product = productRow.Row["ProductName"].ToString();
        string company = this.companyNameComboBox.Text;

        // Return the data row from the selected product.
        rows = tbl.Select("ProductName = '" + product.Replace("'", "''") + "'");

        this.AddData(rows[0], company);
    }
    else
    {
        MessageBox.Show("Please select a product.", "Actions Pane", MessageBoxButtons.OK);
    }
}

In C#, you must create an event handler for the Click event of the button. You can place this code in the Load event handler of the ActionsControl class. For more information on creating event handlers, see How to: Create Event Handlers in Visual Studio Tools for Office.
C#
```
this.Insert.Click += new EventHandler(Insert_Click);
```

Showing the Actions Pane

In this section, you will write code to show the actions pane. The actions pane becomes visible after controls are added to it.

To show the actions pane

In Solution Explorer, right-click ThisDocument.vb or ThisDocument.cs, and then click View Code on the shortcut menu.
Create a new instance of the control at the top of the ThisDocument class so that it looks like the following example:
Visual Basic
```
Dim actions As New ActionsControl
```
C#
```
private ActionsControl actions = new ActionsControl();
```
Add code to the Startup event handler of ThisDocument so that it looks like the following example:

Note

For information on creating event handlers, see How to: Create Event Handlers in Visual Studio Tools for Office.
Visual Basic
```
Me.ActionsPane.Controls.Add(actions)
```
C#
```
this.ActionsPane.Controls.Add(actions);
```

Testing the Application

Now you can test your document to make sure that the actions pane opens when the document is opened. Test for the master/detail relationship in the controls on the actions pane, and make sure that data is populated in a Word table when the Insert button is clicked.

To test your document

Press F5 to run your project.
Confirm that the actions pane is visible.
Select a company in the combo box and verify that the items in the Products list box change.
Select a product, click Insert on the actions pane, and verify that the product details are added to the table in Word.
Insert additional products from various companies.

Next Steps

This walkthrough shows the basics of binding data to controls on an actions pane in Word. Here are some tasks that might come next:

Deploying the project. For more information, see How to: Deploy Office Solutions.
Binding data to controls in Excel. For more information, Walkthrough: Binding Data to Controls on an Excel Actions Pane.
Showing and hiding controls on the actions pane. For more information, see Walkthrough: Changing the Actions Pane According to User Context

Tasks

How to: Add an Actions Pane to Word Documents

Concepts

Actions Pane Overview
Binding Data to Controls Overview