How to: Add ListObject Controls to Worksheets

 

You can add ListObject controls to a Microsoft Office Excel worksheet at design time and at run time in document-level projects.

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

You can also add ListObject controls at run time in VSTO Add-in projects.

This topic describes the following tasks:

For more information about ListObject controls, see ListObject Control.

There are several ways to add ListObject controls to a worksheet in a document-level project at design time: From within Excel, from the Visual Studio Toolbox, and from the Data Sources window.

System_CAPS_ICON_note.jpg 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 Personalizing the IDE.

To use the Ribbon in Excel

  1. On the Insert tab, in the Tables group, click Table.

  2. Select the cell or cells you want to include in the list and click OK.

To use the Toolbox

  1. From the Excel Controls tab of the Toolbox, drag a ListObject to the worksheet.

    The Add ListObject Control dialog box appears.

  2. Select the cell or cells you want to include in the list and click OK.

    If you do not want to keep the default name, you can change the name in the Properties window.

To use the Data Sources window

  1. Open the Data Sources window and create a data source for your project. For more information, see How to: Connect to Data in a Database.

  2. Drag a table from the Data Sources window to your worksheet.

    A data-bound ListObject control is added to the worksheet. For more information, see Data Binding and Windows Forms.

You can add the ListObject control dynamically at run time. This enables you to create the host controls in response to events. Dynamically created list objects are not persisted in the worksheet as host controls when the worksheet is closed. For more information, see Adding Controls to Office Documents at Run Time.

To add a ListObject control to a worksheet programmatically

  1. In the Startup event handler of Sheet1, insert the following code to add a ListObject control to cells A1 through A4.

                Microsoft.Office.Tools.Excel.ListObject employeeData;
                employeeData = this.Controls.AddListObject(this.get_Range("$A$1:$D$4"), "employees");
    

You can add a ListObject control programmatically to any open worksheet in an VSTO Add-in project. Dynamically created list objects are not persisted in the worksheet as host controls when the worksheet is saved and then closed. For more information, see Extending Word Documents and Excel Workbooks in VSTO Add-ins at Run Time.

To add a ListObject control to a worksheet programmatically

  1. The following code generates a worksheet host item that is based on the open worksheet, and then adds a ListObject control to cells A1 through A4.

            private void AddListObject()
            {
                Worksheet worksheet = Globals.Factory.GetVstoObject(
                    Globals.ThisAddIn.Application.ActiveWorkbook.Worksheets[1]);
    
                Microsoft.Office.Tools.Excel.ListObject list1;
                Excel.Range cell = worksheet.Range["$A$1:$D$4"];
                list1 = worksheet.Controls.AddListObject(cell, "list1");
            }
    

Extending Word Documents and Excel Workbooks in VSTO Add-ins at Run Time
Controls on Office Documents
ListObject Control
Automating Excel by Using Extended Objects
Host Items and Host Controls Overview
How to: Resize ListObject Controls
Binding Data to Controls in Office Solutions
Programmatic Limitations of Host Items and Host Controls

Show: