ControlCollection インターフェイス

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

Visual Studio の Office 開発ツールでカスタマイズされた Word 文書上のマネージコントロールのコレクションを表します。

名前空間: 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.Tools.Word.Bookmark コントロールを、指定された既存の Microsoft.Office.Interop.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 インスタンスで指定のコントロールを検索し、最初に見つかったコントロールについて、0 から始まるインデックスを返します。
	IndexOf(String)	指定された名前を持ち、ControlCollection インスタンス内で最初に出現するコントロールを検索します。
	Remove(Object)	指定されたコントロールを ControlCollection インスタンスから削除します。
	Remove(String)	指定されたコントロールを ControlCollection インスタンスから削除します。
	RemoveAt	ControlCollection インスタンス内の指定されたインデックスにあるコントロールを削除します。

このページのトップへ

解説

ControlCollection メソッドおよびプロパティを使用して、Word 文書上のコントロールを管理します。詳細については、「実行時の Office ドキュメントへのコントロールの追加」を参照してください。

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

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

Task (タスク)	操作
ドキュメントにコントロールを追加します。	いずれかの 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 インターフェイス

構文

プロパティ

メソッド

解説

使用方法

参照

参照

その他の技術情報

その他のリソース