Document.Controls プロパティ

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

文書にあるマネージコントロールのコレクションを取得します。

名前空間: Microsoft.Office.Tools.Word
アセンブリ: Microsoft.Office.Tools.Word (Microsoft.Office.Tools.Word.dll 内)

構文

'宣言
ReadOnly Property Controls As ControlCollection
    Get

ControlCollection Controls { get; }

プロパティ値

型: Microsoft.Office.Tools.Word.ControlCollection
文書にあるすべてのマネージコントロールが格納された ControlCollection。

解説

Office ソリューションのドキュメントには、Windows フォームコントロールおよびホストコントロールを含めることができます。詳細については、「Office ドキュメントのコントロール」を参照してください。

実行時にドキュメント上のコントロールを管理するには、Controls プロパティによって返される ControlCollection オブジェクトのメソッドとプロパティを使用します。詳細については、「実行時の Office ドキュメントへのコントロールの追加」を参照してください。

例

次のコード例では、最初の段落にテキストを追加し、その段落を囲む Bookmark コントロールを作成します。この後、文書でのコントロールの総数を示すメッセージボックスを表示します。この例は、アプリケーションレベルのアドインのために作成されています。

Private Sub DocumentControls()
    Dim vstoDoc As Document = Globals.Factory.GetVstoObject(Me.Application.ActiveDocument)
    vstoDoc.Paragraphs(1).Range.InsertParagraphAfter()
    vstoDoc.Paragraphs(1).Range.Text = "This is some sample text."
    vstoDoc.Controls.AddBookmark(vstoDoc.Paragraphs(1).Range, "Bookmark1")
    System.Windows.Forms.MessageBox.Show("Total number of controls: " & _
                                         vstoDoc.Controls.Count.ToString())
End Sub

private void DocumentControls()
{
    Document vstoDoc = Globals.Factory.GetVstoObject(this.Application.ActiveDocument);
    vstoDoc.Paragraphs[1].Range.InsertParagraphAfter();
    vstoDoc.Paragraphs[1].Range.Text = "This is some sample text.";
    vstoDoc.Controls.AddBookmark(vstoDoc.Paragraphs[1].Range, "Bookmark1");
    System.Windows.Forms.MessageBox.Show("Total number of controls: " +
        vstoDoc.Controls.Count.ToString());
}