This documentation is archived and is not being maintained.

Worksheet.Controls Property (2007 System)

Updated: July 2008

Gets the collection of managed controls that are contained on the worksheet.

Namespace:  Microsoft.Office.Tools.Excel
Assembly:  Microsoft.Office.Tools.Excel.v9.0 (in Microsoft.Office.Tools.Excel.v9.0.dll)

[BrowsableAttribute(false)]
public virtual ControlCollection Controls { get; }

Property Value

Type: Microsoft.Office.Tools.Excel.ControlCollection
A ControlCollection that contains all the managed controls on the worksheet.

A worksheet in a Visual Studio Tools for Office solution can contain Windows Forms controls and host controls. For more information, see Controls on Office Documents.

To manage the controls on a worksheet at run time, use the methods and properties of the ControlCollection object returned by the Controls property. For more information, see Adding Controls to Office Documents at Run Time

The following code example uses the Controls property to add a Button to the current worksheet.

This version is for a document-level customization.

private void AddButton()
{
    Button button1 = this.Controls.AddButton(50, 50, 150, 50, "button1");
}

This version is for an application-level add-in.

private void AddButton()
{
    Worksheet vstoWorksheet = ((Excel.Worksheet)
        this.Application.ActiveWorkbook.Worksheets[1]).GetVstoObject();
    System.Windows.Forms.Button button1 = 
        vstoWorksheet.Controls.AddButton(50, 50, 150, 50, "button1");
}

Date

History

Reason

July 2008

Added a version of the code example for an application-level add-in.

SP1 feature change.

Show: