Walkthrough: Bind data to controls on a Word actions pane

Article
03/10/2023

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

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

This walkthrough illustrates the following tasks:

Creating an actions pane with Windows Forms controls that are bound to data.
Using a master/detail relationship to display data in the controls.
Show the actions pane when the application opens.

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 Personalize the Visual Studio IDE.

Prerequisites

You need the following components to complete this walkthrough:

An edition of Visual Studio that includes the Microsoft Office developer tools. For more information, see Configure a computer to develop Office solutions.
Word 2013 or Word 2010 .
Access to a server with the Northwind SQL Server sample database.
Permissions to read from and write to the SQL Server database.

Create the project

The first step is to create a Word Document project.

To create a new project

Create a Word Document project with the name My Word Actions Pane. In the wizard, select Create a new document.

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

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

Add 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, click Add New Item.
In the Add New Item dialog box, select Actions Pane Control, name it ActionsControl, and then click Add.

To add a data source to the project

If the Data Sources window is not visible, display it by, on the menu bar, choosing View > Other Windows > Data Sources.

Note

If Show Data Sources is not available, click 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 by 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.

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 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 on the shortcut menu, and change the following properties.

Property Value

Name Insert

Text Insert
Resize the user control to fit the controls.

Property	Value
Name	Insert
Text	Insert

Set up the data source

To set up the data source, add code to the Load event of the actions pane control to fill the control with data from the DataTable, and 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.

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

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

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 how to create event handlers, see How to: Create event handlers in Office projects.
```
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.
Click the button to the right of the DisplayMember property, and select CompanyName.
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.
Click the button to the right of the DisplayMember property, and select ProductName.
Expand the DataBindings property, click the button to the right of the SelectedValue property, and select None.

Add a method to insert data into a table

The next task is to read the data from the bound controls and populate a table in your Word document. First, create a procedure for formatting the headings in the table, and then 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.

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;
}

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

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.

private void AddData(System.Data.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);
    }
}

Private Sub AddData(ByVal row As System.Data.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

To insert text into a Word table

Add the following code to the Click event handler of the Insert button.

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

    // Check if a product is selected.
    if (this.productNameListBox.SelectedIndex >= 0)
    {
        System.Data.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);
    }
}

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

    Dim tbl As System.Data.DataTable = NorthwindDataSet.Products
    Dim rows() As System.Data.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

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.
```
this.Insert.Click += new EventHandler(Insert_Click);
```

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.
- C#
- VB
```
private ActionsControl actions = new ActionsControl();
```
```
Dim actions As New ActionsControl
```
Add code to the Startup event handler of ThisDocument so that it looks like the following example.
- C#
- VB
```
this.ActionsPane.Controls.Add(actions);
```
```
Me.ActionsPane.Controls.Add(actions)
```

Test the application

Now you can test your document to verify that the actions pane appears 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:

Binding data to controls in Excel. For more information, see Walkthrough: Bind data to controls on an Excel actions pane.
Deploying the project. For more information, see Deploy an Office solution by using ClickOnce.

Walkthrough: Bind data to controls on a Word actions pane

Prerequisites

Create the project

To create a new project

Add controls to the actions pane

To add an actions pane control

To add a data source to the project

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

Set up the data source

To load the control with data

To set data binding properties of the controls

Add a method to insert data into a table

To format the table headings

To create the table

To insert text into a Word table

Show the actions pane

To show the actions pane

Test the application

To test your document

Next steps

Feedback

Feedback

Additional resources

Walkthrough: Bind data to controls on a Word actions pane

Prerequisites

Create the project

To create a new project

Add controls to the actions pane

To add an actions pane control

To add a data source to the project

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

Set up the data source

To load the control with data

To set data binding properties of the controls

Add a method to insert data into a table

To format the table headings

To create the table

To insert text into a Word table

Show the actions pane

To show the actions pane

Test the application

To test your document

Next steps

Related content

Feedback

Feedback

Additional resources