ControlCollection 接口
表示 Office 解决方案中 Excel 工作表中的托管控件的集合。
命名空间: Microsoft.Office.Tools.Excel
程序集: Microsoft.Office.Tools.Excel(在 Microsoft.Office.Tools.Excel.dll 中)
语法
声明
<GuidAttribute("0B027FC3-018C-4917-AE33-A09E0A30A661")> _
Public Interface ControlCollection _
Inherits IEnumerable
[GuidAttribute("0B027FC3-018C-4917-AE33-A09E0A30A661")]
public interface ControlCollection : IEnumerable
ControlCollection 类型公开以下成员。
属性
名称 | 说明 | |
---|---|---|
Count | 获取 ControlCollection 中控件的数目。 | |
Item[Int32] | 获取指定索引处的控件。 | |
Item[String] | 获取具有指定名称的控件。 |
页首
方法
名称 | 说明 | |
---|---|---|
AddChart(Range, String) | 在工作表中的指定范围添加一个新的 Chart 控件。 | |
AddChart(Double, Double, Double, Double, String) | 按照指定的大小和位置向工作表添加一个新的 Chart 控件。 | |
AddControl(Control, Range, String) | 将指定的 Control 添加到 ControlCollection 中的指定范围。 | |
AddControl(Control, Double, Double, Double, Double, String) | 按照指定的位置和大小将指定的 Control 添加到 ControlCollection。 | |
AddListObject(ListObject) | 将一个 Visual Studio Microsoft.Office.Tools.Excel.ListObject 添加到基于指定的本机 Microsoft.Office.Interop.Excel.ListObject 的控件集合。 | |
AddListObject(Range, String) | 在工作表中的指定范围添加一个新的 ListObject 控件。 | |
AddNamedRange | 在工作表中的指定范围添加一个新的 NamedRange 控件。 | |
Contains(Object) | 确定指定的控件是否为 ControlCollection 实例的成员。 | |
Contains(String) | 确定具有指定名称的控件是否为 ControlCollection 实例的成员。 | |
GetEnumerator | 返回一个循环访问集合的枚举数。 (继承自 IEnumerable。) | |
IndexOf(Object) | 搜索指定控件,并返回该控件在 ControlCollection 实例中的第一个匹配项的从零开始的索引。 | |
IndexOf(String) | 搜索具有指定名称的控件在 ControlCollection 实例中的第一个匹配项。 | |
Remove(Object) | 从 ControlCollection 实例中移除指定的控件。 | |
Remove(String) | 从 ControlCollection 实例中移除具有指定名称的控件。 | |
RemoveAt | 移除 ControlCollection 实例中指定索引处的控件。 |
页首
备注
使用 ControlCollection 接口的方法和属性来管理 Excel 工作表上的控件。 有关更多信息,请参见 在运行时向 Office 文档添加控件。
您不能在代码中创建此接口的实例,因为它没有任何公共构造函数。 若要获取文档级项目中此接口的实例,请使用您项目中的 Sheetn 类之一的 Controls 属性。 若要获取文档级项目中此接口的实例,请使用在运行时以编程方式创建的 Worksheet 宿主项的 Controls 属性。 有关更多信息,请参见 在运行时在应用程序级外接程序中扩展 Word 文档和 Excel 工作簿。
下表演示如何使用 ControlCollection 成员来执行与文档中的控件相关的某些常规任务。
任务 |
操作 |
---|---|
将控件添加到工作表。 |
使用 Add<控件> 方法之一。 例如,要想添加 Microsoft.Office.Tools.Excel.ListObject,就需要使用 AddListObject 方法。 |
从工作表中移除控件。 |
请使用 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。