ControlCollection 接口

2011-08-12

表示 Word 文档中的托管控件的集合，该文档是使用 Visual Studio 中的 Office 开发工具自定义的。

命名空间： Microsoft.Office.Tools.Word
程序集： Microsoft.Office.Tools.Word（在 Microsoft.Office.Tools.Word.dll 中）

语法

声明
<GuidAttribute("E1180F09-B903-4D03-8D30-2845219AEE2C")> _
Public Interface ControlCollection _
    Inherits IEnumerable

[GuidAttribute("E1180F09-B903-4D03-8D30-2845219AEE2C")]
public interface ControlCollection : IEnumerable

ControlCollection 类型公开以下成员。

属性

	名称	说明
	Capacity	获取或设置 ControlCollection 可包含的控件数。
	Count	获取 ControlCollection 中控件的数目。
	Item[Int32]	获取指定索引处的控件。
	Item[Object]	获取指定的控件。
	Item[String]	获取具有指定名称的控件。

页首

方法

	名称	说明
	AddBookmark(Bookmark, String)	向文档中指定的现有 Microsoft.Office.Interop.Word.Bookmark 的位置添加一个新的 Microsoft.Office.Tools.Word.Bookmark 控件。
	AddBookmark(Range, String)	在指定的范围内向文档添加一个新的 Bookmark 控件。
	AddBuildingBlockGalleryContentControl(String)	在文档中当前选定的位置添加一个新的 BuildingBlockGalleryContentControl。
	AddBuildingBlockGalleryContentControl(ContentControl, String)	将新 BuildingBlockGalleryContentControl 添加到集合中。新控件基于文件中已有的本机内容控件。
	AddBuildingBlockGalleryContentControl(Range, String)	在文档中的指定范围内添加一个新的 BuildingBlockGalleryContentControl。
	AddComboBoxContentControl(String)	在文档中当前选定的位置添加一个新的 ComboBoxContentControl。
	AddComboBoxContentControl(ContentControl, String)	将新 ComboBoxContentControl 添加到集合中。新控件基于文件中已有的本机内容控件。
	AddComboBoxContentControl(Range, String)	在文档中的指定范围内添加一个新的 ComboBoxContentControl。
	AddContentControl(ContentControl, String)	添加一个基于文档中的本机内容控件的新 ContentControl。
	AddContentControl(String, WdContentControlType)	将一个指定类型的新 ContentControl 添加到文档中当前选定的位置。
	AddContentControl(Range, String, WdContentControlType)	将一个指定类型的新 ContentControl 添加到文档中的指定范围。
	AddControl(Control, Range, Single, Single, String)	在指定范围内以指定大小向 ControlCollection 添加指定控件。
	AddControl(Control, Single, Single, Single, Single, String)	在指定位置以指定大小向 ControlCollection 添加指定控件。
	AddDatePickerContentControl(String)	在文档中当前选定的位置添加一个新的 DatePickerContentControl。
	AddDatePickerContentControl(ContentControl, String)	将新 DatePickerContentControl 添加到集合中。新控件基于文件中已有的本机内容控件。
	AddDatePickerContentControl(Range, String)	在文档中的指定范围内添加一个新的 DatePickerContentControl。
	AddDropDownListContentControl(String)	在文档中当前选定的位置添加一个新的 DropDownListContentControl。
	AddDropDownListContentControl(ContentControl, String)	将新 DropDownListContentControl 添加到集合中。新控件基于文件中已有的本机内容控件。
	AddDropDownListContentControl(Range, String)	在文档中的指定范围内添加一个新的 DropDownListContentControl。
	AddGroupContentControl(String)	在文档中当前选定的位置添加一个新的 GroupContentControl。
	AddGroupContentControl(ContentControl, String)	添加一个基于文档中的本机内容控件的新 GroupContentControl。
	AddGroupContentControl(Range, String)	在文档中的指定范围内添加一个新的 GroupContentControl。
	AddPictureContentControl(String)	在文档中当前选定的位置添加一个新的 PictureContentControl。
	AddPictureContentControl(ContentControl, String)	添加一个基于文档中的本机内容控件的新 PictureContentControl。
	AddPictureContentControl(Range, String)	在文档中的指定范围内添加一个新的 PictureContentControl。
	AddPlainTextContentControl(String)	在文档中当前选定的位置添加一个新的 PlainTextContentControl。
	AddPlainTextContentControl(ContentControl, String)	添加一个基于文档中的本机内容控件的新 PlainTextContentControl。
	AddPlainTextContentControl(Range, String)	在文档中的指定范围内添加一个新的 PlainTextContentControl。
	AddRichTextContentControl(String)	在文档中当前选定的位置添加一个新的 RichTextContentControl。
	AddRichTextContentControl(ContentControl, String)	添加一个基于文档中的本机内容控件的新 RichTextContentControl。
	AddRichTextContentControl(Range, String)	在文档中的指定范围内添加一个新的 RichTextContentControl。
	Contains(Object)	确定指定的控件是否为 ControlCollection 实例的成员。
	Contains(String)	确定具有指定名称的控件是否为 ControlCollection 实例的成员。
	GetEnumerator	返回一个循环访问集合的枚举数。（继承自 IEnumerable。）
	GetInlineShapeForControl	获取指定控件的基础 InlineShape。
	GetShapeForControl	获取指定控件的基础 Shape。
	IndexOf(Object)	搜索指定控件，并返回该控件在 ControlCollection 实例中的第一个匹配项的从零开始的索引。
	IndexOf(String)	在 ControlCollection 实例中搜索具有指定名称的控件的第一个匹配项。
	Remove(Object)	从 ControlCollection 实例中移除指定的控件。
	Remove(String)	从 ControlCollection 实例中移除指定的控件。
	RemoveAt	移除 ControlCollection 实例中指定索引处的控件。

页首

备注

使用 ControlCollection 方法和属性来管理 Word 文档中的控件。有关更多信息，请参见在运行时向 Office 文档添加控件。

若要获取文档级项目中的 ControlCollection 对象，请使用您项目中的 ThisDocument 类的 Controls 属性。若要获取应用程序级项目中的 ControlCollection 对象，请使用在运行时以编程方式创建的 Document 宿主项的 Controls 属性。有关更多信息，请参见在运行时在应用程序级外接程序中扩展 Word 文档和 Excel 工作簿。

下表演示如何使用 ControlCollection 成员来执行与文档中的控件相关的某些常规任务。

任务	操作
将控件添加到文档。	使用 AddControlName 方法之一。例如，要添加内容控件，请使用 AddContentControl 方法。
从文档中移除控件。	请使用 Remove 方法。
确定控件是否在集合中。	将控件及其名称传给 Contains 方法。
获取集合中控件的索引。	将控件及其名称传递给 IndexOf 方法。
从集合获取控件。	将该控件的索引或名称传递给 Item 属性。

提示

此接口由 Visual Studio Tools for Office 运行时实现。不应在代码中实现此接口。有关更多信息，请参见 Visual Studio Tools for Office Runtime 概述。

用法

本文档介绍面向 .NET Framework 4 的 Office 项目中所用此类型的版本。在面向 .NET Framework 3.5 的项目中，此类型可能具有不同的成员，因此本文档为此类型提供的代码示例可能并不适用。有关在面向 .NET Framework 3.5 的项目中使用此类型的文档，请参见 Visual Studio 2008 文档中以下参考部分：https://go.microsoft.com/fwlink/?LinkId=160658。

请参见

参考

Microsoft.Office.Tools.Word 命名空间

其他资源

在运行时向 Office 文档添加控件

宿主控件的帮助器方法

通过

ControlCollection 接口

语法

属性

方法

备注

用法

请参见

参考

其他资源

其他资源