ControlCollection Interface

Definition

Represents a collection of managed controls on an Excel worksheet in an Office solution.

[System.Runtime.InteropServices.Guid("0B027FC3-018C-4917-AE33-A09E0A30A661")]
public interface ControlCollection : System.Collections.IEnumerable
Attributes
Implements

Remarks

Use the methods and properties of the ControlCollection interface to manage controls on an Excel worksheet. For more information, see Adding Controls to Office Documents at Run Time.

You cannot create an instance of this interface in your code, because it does not have any public constructors. To get an instance of this interface in a document-level project, use the Controls property of one of the Sheetn classes in your project. To get an instance of this interface in a document-level project, use the Controls property of a Worksheet host item that you create programmatically at run time. For more information, see Extending Word Documents and Excel Workbooks in VSTO Add-ins at Run Time.

The following table shows how to use ControlCollection members to perform some common tasks related to controls on documents.

Task Action
Add a control to the worksheet. Use one of the Add*<control>* methods. For example, to add a Microsoft.Office.Tools.Excel.ListObject, use the AddListObject method.
Remove a control from the worksheet. Use the Remove method.
Determine whether a control is in the collection. Pass the control or its name to the Contains method.
Get the index of a control in the collection. Pass the control or its name to the IndexOf method.
Get a control from the collection. Pass the index or name of the control to the Item[String] property.

Note

This interface is implemented by the Visual Studio Tools for Office runtime. It is not intended to be implemented in your code. For more information, see Visual Studio Tools for Office Runtime Overview.

Usage

This documentation describes the version of this type that is used in Office projects that target the .NET Framework 4 or later. In projects that target the .NET Framework 3.5, this type might have different members and the code examples provided for this type might not work. For documentation about this type in projects that target the .NET Framework 3.5, see the following reference section in the Visual Studio 2008 documentation: http://go.microsoft.com/fwlink/?LinkId=160658.

Properties

Count

Gets the number of controls in the ControlCollection.

Item[Int32]

Gets the control at the specified index.

Item[String]

Gets the control with the specified name.

Methods

AddChart(Double, Double, Double, Double, String)

Adds a new Chart control to the worksheet in the specified size and location.

AddChart(Range, String)

Adds a new Chart control to the worksheet at the range specified.

AddControl(Control, Double, Double, Double, Double, String)

Adds the specified Control to the ControlCollection at the location and size specified.

AddControl(Control, Range, String)

Adds the specified Control to the ControlCollection at the specified range.

AddListObject(ListObject)

Adds a Visual Studio ListObject to the control collection based on the specified native ListObject.

AddListObject(Range, String)

Adds a new ListObject control to the worksheet at the range specified.

AddNamedRange(Range, String)

Adds a new NamedRange control to the worksheet at the range specified.

Contains(Object)

Determines whether the specified control is a member of the ControlCollection instance.

Contains(String)

Determines whether a control with the specified name is a member of the ControlCollection instance.

IndexOf(Object)

Searches for the specified control and returns the zero-based index of the first occurrence in the ControlCollection instance.

IndexOf(String)

Searches for the first occurrence of a control with the specified name in the ControlCollection instance.

Remove(Object)

Removes the specified control from the ControlCollection instance.

Remove(String)

Removes the control with the specified name from the ControlCollection instance.

RemoveAt(Int32)

Removes the control at the specified index in the ControlCollection instance.

Extension Methods

AddButton(ControlCollection, Range, String)

Adds a new Button control to the worksheet at the range specified.

AddButton(ControlCollection, Double, Double, Double, Double, String)

Adds a new Button control to the worksheet in the specified size and location.

AddCheckBox(ControlCollection, Range, String)

Adds a new CheckBox control to the worksheet at the range specified.

AddCheckBox(ControlCollection, Double, Double, Double, Double, String)

Adds a new CheckBox control to the worksheet in the specified size and location.

AddCheckedListBox(ControlCollection, Range, String)

Adds a new CheckedListBox control to the worksheet at the range specified.

AddCheckedListBox(ControlCollection, Double, Double, Double, Double, String)

Adds a new CheckedListBox control to the worksheet in the specified size and location.

AddComboBox(ControlCollection, Range, String)

Adds a new ComboBox control to the worksheet at the range specified.

AddComboBox(ControlCollection, Double, Double, Double, Double, String)

Adds a new ComboBox control to the worksheet in the specified size and location.

AddDataGridView(ControlCollection, Range, String)

Adds a new DataGridView control to the worksheet at the range specified.

AddDataGridView(ControlCollection, Double, Double, Double, Double, String)

Adds a new DataGridView control to the worksheet in the specified size and location.

AddDateTimePicker(ControlCollection, Range, String)

Adds a new DateTimePicker control to the worksheet at the range specified.

AddDateTimePicker(ControlCollection, Double, Double, Double, Double, String)

Adds a new DateTimePicker control to the worksheet in the specified size and location.

AddDomainUpDown(ControlCollection, Range, String)

Adds a new DomainUpDown control to the worksheet at the range specified.

AddDomainUpDown(ControlCollection, Double, Double, Double, Double, String)

Adds a new DomainUpDown control to the worksheet in the specified size and location.

AddHScrollBar(ControlCollection, Range, String)

Adds a new HScrollBar control to the worksheet at the range specified.

AddHScrollBar(ControlCollection, Double, Double, Double, Double, String)

Adds a new HScrollBar control to the worksheet in the specified size and location.

AddLabel(ControlCollection, Range, String)

Adds a new Label control to the worksheet at the range specified.

AddLabel(ControlCollection, Double, Double, Double, Double, String)

Adds a new Label control to the worksheet in the specified size and location.

AddLinkLabel(ControlCollection, Range, String)

Adds a new LinkLabel control to the worksheet at the range specified.

AddLinkLabel(ControlCollection, Double, Double, Double, Double, String)

Adds a new LinkLabel control to the worksheet in the specified size and location.

AddListBox(ControlCollection, Range, String)

Adds a new ListBox control to the worksheet at the range specified.

AddListBox(ControlCollection, Double, Double, Double, Double, String)

Adds a new ListBox control to the worksheet in the specified size and location.

AddListView(ControlCollection, Range, String)

Adds a new ListView control to the worksheet at the range specified.

AddListView(ControlCollection, Double, Double, Double, Double, String)

Adds a new ListView control to the worksheet in the specified size and location.

AddMaskedTextBox(ControlCollection, Range, String)

Adds a new MaskedTextBox control to the worksheet at the range specified.

AddMaskedTextBox(ControlCollection, Double, Double, Double, Double, String)

Adds a new MaskedTextBox control to the document in the specified size and location.

AddMonthCalendar(ControlCollection, Range, String)

Adds a new MonthCalendar control to the worksheet at the range specified.

AddMonthCalendar(ControlCollection, Double, Double, Double, Double, String)

Adds a new MonthCalendar control to the worksheet in the specified size and location.

AddNumericUpDown(ControlCollection, Range, String)

Adds a new NumericUpDown control to the worksheet at the range specified.

AddNumericUpDown(ControlCollection, Double, Double, Double, Double, String)

Adds a new NumericUpDown control to the worksheet in the specified size and location.

AddPictureBox(ControlCollection, Range, String)

Adds a new PictureBox control to the worksheet at the range specified.

AddPictureBox(ControlCollection, Double, Double, Double, Double, String)

Adds a new PictureBox control to the worksheet in the specified size and location.

AddProgressBar(ControlCollection, Range, String)

Adds a new ProgressBar control to the worksheet at the range specified.

AddProgressBar(ControlCollection, Double, Double, Double, Double, String)

Adds a new ProgressBar control to the worksheet in the specified size and location.

AddPropertyGrid(ControlCollection, Range, String)

Adds a new PropertyGrid control to the worksheet at the range specified.

AddPropertyGrid(ControlCollection, Double, Double, Double, Double, String)

Adds a new PropertyGrid control to the worksheet in the specified size and location.

AddRadioButton(ControlCollection, Range, String)

Adds a new RadioButton control to the worksheet at the range specified.

AddRadioButton(ControlCollection, Double, Double, Double, Double, String)

Adds a new RadioButton control to the worksheet in the specified size and location.

AddRichTextBox(ControlCollection, Range, String)

Adds a new RichTextBox control to the worksheet at the range specified.

AddRichTextBox(ControlCollection, Double, Double, Double, Double, String)

Adds a new RichTextBox control to the worksheet in the specified size and location.

AddTextBox(ControlCollection, Range, String)

Adds a new TextBox control to the worksheet at the range specified.

AddTextBox(ControlCollection, Double, Double, Double, Double, String)

Adds a new TextBox control to the worksheet in the specified size and location.

AddTrackBar(ControlCollection, Range, String)

Adds a new TrackBar control to the worksheet at the range specified.

AddTrackBar(ControlCollection, Double, Double, Double, Double, String)

Adds a new TrackBar control to the worksheet in the specified size and location.

AddTreeView(ControlCollection, Range, String)

Adds a new TreeView control to the worksheet at the range specified.

AddTreeView(ControlCollection, Double, Double, Double, Double, String)

Adds a new TreeView control to the worksheet in the specified size and location.

AddVScrollBar(ControlCollection, Range, String)

Adds a new VScrollBar control to the worksheet at the range specified.

AddVScrollBar(ControlCollection, Double, Double, Double, Double, String)

Adds a new VScrollBar control to the worksheet in the specified size and location.

AddWebBrowser(ControlCollection, Range, String)

Adds a new WebBrowser control to the worksheet at the range specified.

AddWebBrowser(ControlCollection, Double, Double, Double, Double, String)

Adds a new WebBrowser control to the worksheet in the specified size and location.

Applies to