ControlCollection インターフェイス

[アーティクル]
08/09/2011

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)	指定されたネイティブな Microsoft.Office.Interop.Excel.ListObject に基づくコントロールコレクションに Visual Studio Microsoft.Office.Tools.Excel.ListObject を追加します。
	AddListObject(Range, String)	新しい ListObject コントロールをワークシートの指定の範囲に追加します。
	AddNamedRange	新しい NamedRange コントロールをワークシートの指定の範囲に追加します。
	Contains(Object)	指定したコントロールが ControlCollection インスタンスのメンバーかどうかを判断します。
	Contains(String)	指定した名前のコントロールが ControlCollection インスタンスのメンバーかどうかを判断します。
	GetEnumerator	コレクションを反復処理する列挙子を返します。 (IEnumerable から継承されます。)
	IndexOf(Object)	ControlCollection インスタンスで指定のコントロールを検索し、最初に見つかったコントロールについて、0 から始まるインデックスを返します。
	IndexOf(String)	ControlCollection インスタンス内で、指定した名前のコントロールが最初に見つかる場所を検索します。
	Remove(Object)	指定したコントロールを ControlCollection インスタンスから削除します。
	Remove(String)	指定した名前のコントロールを ControlCollection インスタンスから削除します。
	RemoveAt	指定したインデックスのコントロールを ControlCollection インスタンスから削除します。

このページのトップへ

解説

ControlCollection インターフェイスのメソッドとプロパティを使用して、Excel ワークシート上のコントロールを管理します。詳細については、「実行時の Office ドキュメントへのコントロールの追加」を参照してください。

コードでこのインターフェイスのインスタンスを作成することはできません。これにはパブリックコンストラクターがないからです。ドキュメントレベルのプロジェクトのこのインターフェイスのインスタンスを取得するには、プロジェクトの Sheetn クラスの 1 つの Controls プロパティを使用します。ドキュメントレベルのプロジェクトのこのインターフェイスのインスタンスを取得するには、実行時にプログラムで作成される Worksheet ホスト項目の Controls プロパティを使用します。詳細については、「アプリケーションレベルのアドインにおける実行時の Word 文書や Excel ブックの拡張」を参照してください。

ControlCollection メンバーを使用して文書上のコントロールに関連する一般的なタスクを実行する方法について、次の表に示します。

Task (タスク)	操作
ワークシートにコントロールを追加します。	いずれかの Add<control> メソッドを使用します。たとえば、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 を参照してください。

参照

Microsoft.Office.Tools.Excel 名前空間

次の方法で共有

ControlCollection インターフェイス

構文

プロパティ

メソッド

解説

使用方法

参照

参照

その他のリソース