ControlCollection Interface

Represents a collection of managed controls on a Word document that has been customized by using the Office development tools in Visual Studio.

Namespace:  Microsoft.Office.Tools.Word
Assembly:  Microsoft.Office.Tools.Word (in Microsoft.Office.Tools.Word.dll)

Syntax

'Declaration
<GuidAttribute("E1180F09-B903-4D03-8D30-2845219AEE2C")> _
Public Interface ControlCollection _
    Inherits IEnumerable
[GuidAttribute("E1180F09-B903-4D03-8D30-2845219AEE2C")]
public interface ControlCollection : IEnumerable

The ControlCollection type exposes the following members.

Properties

  Name Description
Public property Capacity Gets or sets the number of controls that the ControlCollection can contain.
Public property Count Gets the number of controls in the ControlCollection.
Public property Item[Int32] Gets the control at the specified index.
Public property Item[Object] Gets the specified control.
Public property Item[String] Gets the control with the specified name.

Top

Methods

  Name Description
Public method AddBookmark(Bookmark, String) Adds a new Microsoft.Office.Tools.Word.Bookmark control to the document at the location of the existing Microsoft.Office.Interop.Word.Bookmark specified.
Public method AddBookmark(Range, String) Adds a new Bookmark control to the document at the specified range.
Public method AddBuildingBlockGalleryContentControl(String) Adds a new BuildingBlockGalleryContentControl at the current selection in the document.
Public method AddBuildingBlockGalleryContentControl(ContentControl, String) Adds a new BuildingBlockGalleryContentControl to the collection. The new control is based on a native content control that is already in the document.
Public method AddBuildingBlockGalleryContentControl(Range, String) Adds a new BuildingBlockGalleryContentControl at the specified range in the document.
Public method AddComboBoxContentControl(String) Adds a new ComboBoxContentControl at the current selection in the document.
Public method AddComboBoxContentControl(ContentControl, String) Adds a new ComboBoxContentControl to the collection. The new control is based on a native content control that is already in the document.
Public method AddComboBoxContentControl(Range, String) Adds a new ComboBoxContentControl at the specified range in the document.
Public method AddContentControl(ContentControl, String) Adds a new ContentControl that is based on a native content control in the document.
Public method AddContentControl(String, WdContentControlType) Adds a new ContentControl of the specified type at the current selection in the document.
Public method AddContentControl(Range, String, WdContentControlType) Adds a new ContentControl of the specified type at the specified range in the document.
Public method AddControl(Control, Range, Single, Single, String) Adds the specified control to the ControlCollection at the specified range, with the specified size.
Public method AddControl(Control, Single, Single, Single, Single, String) Adds the specified control to the ControlCollection at the specified location, with the specified size.
Public method AddDatePickerContentControl(String) Adds a new DatePickerContentControl at the current selection in the document.
Public method AddDatePickerContentControl(ContentControl, String) Adds a new DatePickerContentControl to the collection. The new control is based on a native content control that is already in the document.
Public method AddDatePickerContentControl(Range, String) Adds a new DatePickerContentControl at the specified range in the document.
Public method AddDropDownListContentControl(String) Adds a new DropDownListContentControl at the current selection in the document.
Public method AddDropDownListContentControl(ContentControl, String) Adds a new DropDownListContentControl to the collection. The new control is based on a native content control that is already in the document.
Public method AddDropDownListContentControl(Range, String) Adds a new DropDownListContentControl at the specified range in the document.
Public method AddGroupContentControl(String) Adds a new GroupContentControl at the current selection in the document.
Public method AddGroupContentControl(ContentControl, String) Adds a new GroupContentControl that is based on a native content control in the document.
Public method AddGroupContentControl(Range, String) Adds a new GroupContentControl at the specified range in the document.
Public method AddPictureContentControl(String) Adds a new PictureContentControl at the current selection in the document.
Public method AddPictureContentControl(ContentControl, String) Adds a new PictureContentControl that is based on a native content control in the document.
Public method AddPictureContentControl(Range, String) Adds a new PictureContentControl at the specified range in the document.
Public method AddPlainTextContentControl(String) Adds a new PlainTextContentControl at the current selection in the document.
Public method AddPlainTextContentControl(ContentControl, String) Adds a new PlainTextContentControl that is based on a native content control in the document.
Public method AddPlainTextContentControl(Range, String) Adds a new PlainTextContentControl at the specified range in the document.
Public method AddRichTextContentControl(String) Adds a new RichTextContentControl at the current selection in the document.
Public method AddRichTextContentControl(ContentControl, String) Adds a new RichTextContentControl that is based on a native content control in the document.
Public method AddRichTextContentControl(Range, String) Adds a new RichTextContentControl at the specified range in the document.
Public method Contains(Object) Determines whether the specified control is a member of the ControlCollection instance.
Public method Contains(String) Determines whether a control with the specified name is a member of the ControlCollection instance.
Public method GetEnumerator Returns an enumerator that iterates through a collection. (Inherited from IEnumerable.)
Public method GetInlineShapeForControl Gets the underlying InlineShape for the specified control.
Public method GetShapeForControl Gets the underlying Shape for the specified control.
Public method IndexOf(Object) Searches for the specified control and returns the zero-based index of the first occurrence in the ControlCollection instance.
Public method IndexOf(String) Searches for the first occurrence of a control with the specified name in the ControlCollection instance.
Public method Remove(Object) Removes the specified control from the ControlCollection instance.
Public method Remove(String) Removes the specified control from the ControlCollection instance.
Public method RemoveAt Removes the control at the specified index in the ControlCollection instance.

Top

Remarks

Use the ControlCollection methods and properties to manage controls on a Word document. For more information, see Adding Controls to Office Documents at Run Time.

To get an ControlCollection object in a document-level project, use the Controls property of the ThisDocument class in your project. To get an ControlCollection object in an application-level project, use the Controls property of a Document host item that you create programmatically at run time. For more information, see Extending Word Documents and Excel Workbooks in Application-Level 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 document.

Use one of the AddControlName methods. For example, to add a content control, use the AddContentControl method.

Remove a control from the document.

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 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. 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.

See Also

Reference

Microsoft.Office.Tools.Word Namespace

Other Resources

Adding Controls to Office Documents at Run Time

Helper Methods for Host Controls