Share via

Adding Controls to Office Documents at Run Time

  • Article

You can add controls to a Microsoft Office Word document and Microsoft Office Excel workbook at run time. You can also remove them at run time. Controls that you add or remove at run time are called dynamic controls.

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

This topic describes the following:

  • Managing controls at run time by using the control collections.

  • Adding host controls to documents.

  • Adding Windows Forms controls to documents.

link to video For a related video demonstration, see How Do I: Add Controls to a Document Surface at Runtime?.

Managing Controls at Run Time by Using the Control Collections

To add, get, or remove controls at run time, use helper methods of Microsoft.Office.Tools.Excel.ControlCollection and Microsoft.Office.Tools.Word.ControlCollection objects.

The way that you access these objects depends on the type of project you are developing:

Adding Controls

The Microsoft.Office.Tools.Excel.ControlCollection and Microsoft.Office.Tools.Word.ControlCollection types include helper methods that you can use to add host controls and common Windows Forms controls to documents and worksheets. Each method name has the format Addcontrol class, where control class is the class name of the control that you want to add. For example, to add a NamedRange control to your document, use the AddNamedRange method.

The following code example adds a NamedRange to Sheet1 in a document-level project for Excel.

Dim range1 As Excel.Range = Globals.Sheet1.Range("A1", "D5")
Dim namedRange1 As Microsoft.Office.Tools.Excel.NamedRange = _
    Globals.Sheet1.Controls.AddNamedRange(range1, "ChartSource")

Excel.Range range1 = Globals.Sheet1.Range["A1", "D5"];
Microsoft.Office.Tools.Excel.NamedRange namedRange1 =
    Globals.Sheet1.Controls.AddNamedRange(range1, "ChartSource");

Accessing and Deleting Controls

You can use the Controls property of a Microsoft.Office.Tools.Excel.Worksheet or Microsoft.Office.Tools.Word.Document to iterate through all the controls in your document, including the controls you added at design time. Controls that you add at design time are also called static controls.

You can remove dynamic controls by calling the Delete method of the control, or by calling the Remove method of each Controls collection. The following code example uses the Remove method to remove a NamedRange from Sheet1 in a document-level project for Excel.

Globals.Sheet1.Controls.Remove("ChartSource")

Globals.Sheet1.Controls.Remove("ChartSource");

You cannot remove static controls at run time. If you try to use the Delete or Remove method to remove a static control, a CannotRemoveControlException will be thrown.

Note

Do not programmatically remove controls in the Shutdown event handler of the document. The UI elements of the document are no longer available when the Shutdown event is raised. If you want to remove controls before the document closes, add your code to the event handler for another event, such as Document.BeforeClose or Document.BeforeSave for Word, or Workbook.BeforeClose, or Workbook.BeforeSave for Excel.

Adding Host Controls to Documents

When you programmatically add host controls to documents, you must provide a name that uniquely identifies the control, and you must specify where to add the control on the document. For specific instructions, see the following topics:

For more information about host controls, see Host Items and Host Controls Overview.

When a document is saved and then closed, all dynamically created host controls are disconnected from their events and they lose their data binding functionality. You can add code to your solution to re-create the host controls when the document is reopened. For more information, see Persisting Dynamic Controls in Office Documents.

Note

Helper methods are not provided for the following host controls, because these controls cannot be added programmatically to documents: XmlMappedRange, XMLNode, and XMLNodes.

Adding Windows Forms Controls to Documents

When you programmatically add a Windows Forms control to a document, you must provide the location of the control and a name that uniquely identifies the control. The Visual Studio Tools for Office runtime provides helper methods for each control. These methods are overloaded so that you can pass either a range or specific coordinates for the location of the control.

When a document is saved and then closed, all dynamically created Windows Forms controls are removed from the document. You can add code to your solution to re-create the controls when the document is reopened. If you create dynamic Windows Forms controls by using an application-level add-in, the ActiveX wrappers for the controls are left in the document. For more information, see Persisting Dynamic Controls in Office Documents.

Note

Windows Forms controls cannot be programmatically added to protected documents. If you programmatically unprotect a Word document or Excel worksheet to add a control, you must write additional code to remove the control's ActiveX wrapper when the document is closed. The control's ActiveX wrapper is not automatically deleted from protected documents.

Adding Custom Controls

If you want to add a System.Windows.Forms.Control that is not supported by the available helper methods, such as a custom user control, use the following methods:

To add the control, pass the System.Windows.Forms.Control, a location for the control, and a name that uniquely identifies the control to the AddControl method. The AddControl method returns an object that defines how the control interacts with the worksheet or document. The AddControl method returns a Microsoft.Office.Tools.Excel.ControlSite (for Excel) or a Microsoft.Office.Tools.Word.ControlSite object (for Word).

The following code example demonstrates how to use the AddControl(Control, Range, String) method to dynamically add a custom user control to a worksheet in a document-level Excel project. In this example, the user control is named UserControl1, and the Range is named range1. To use this example, run it from a Sheetn class in the project.

Dim customControl As New UserControl1()

Dim dynamicControl As Microsoft.Office.Tools.Excel.ControlSite = _
    Me.Controls.AddControl(customControl, range1, "dynamic")

UserControl1 customControl = new UserControl1();

Microsoft.Office.Tools.Excel.ControlSite dynamicControl =
    this.Controls.AddControl(customControl, range1, "dynamic");

Using Members of Custom Controls

After using one of the AddControl methods to add a control to a worksheet or document, you now have two different control objects:

  • The System.Windows.Forms.Control that represents the custom control.

  • The ControlSite, OLEObject, or OLEControl object that represents the control after it was added to the worksheet or document.

Many properties and methods are shared between these controls. It is important that you access these members through the appropriate control:

  • To access members that belong only to the custom control, use the System.Windows.Forms.Control.

  • To access members that are shared by the controls, use the ControlSite, OLEObject, or OLEControl object.

If you access a shared member from the System.Windows.Forms.Control, it might fail without warning or notification, or it can produce invalid results. Always use methods or properties of the ControlSite, OLEObject, or OLEControl object unless the method or property needed is not available; only then should you reference the System.Windows.Forms.Control.

For example, both the ControlSite class and the System.Windows.Forms.Control class have a Top property. To get or set the distance between the top of the control and the top of the document, use the Top property of the ControlSite, not the Top property of the System.Windows.Forms.Control.

' Property is set in relation to the document.
dynamicControl.Top = 100

' Property is set in relation to the container control.
customControl.Top = 100

// Property is set in relation to the document.
dynamicControl.Top = 100;

// Property is set in relation to the container control.
customControl.Top = 100;

See Also

Tasks

How to: Add ListObject Controls to Worksheets

How to: Add NamedRange Controls to Worksheets

How to: Add Chart Controls to Worksheets

How to: Add Content Controls to Word Documents

How to: Add Bookmark Controls to Word Documents

How to: Add Windows Forms Controls to Office Documents

Concepts

Persisting Dynamic Controls in Office Documents

Windows Forms Controls on Office Documents Overview

Other Resources

Controls on Office Documents