Document.Controls プロパティ (2007 System)

[アーティクル]
08/22/2008

更新 : 2008 年 7 月

文書内のすべての Windows フォームコントロールとホストコントロールのコレクションを取得します。

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

構文

'宣言
<BrowsableAttribute(False)> _
Public Overridable ReadOnly Property Controls As ControlCollection
'使用
Dim instance As Document
Dim value As ControlCollection

value = instance.Controls

[BrowsableAttribute(false)]
public virtual ControlCollection Controls { get; }

プロパティ値

型 : Microsoft.Office.Tools.Word.ControlCollection

文書内のすべての Windows フォームコントロールとホストコントロールを格納する ControlCollection。

解説

Visual Studio Tools for Office のドキュメントレベルのカスタマイズの一部である文書には、Windows フォームコントロールとホストコントロールを表示できます。詳細については、「Office ドキュメントのコントロール」を参照してください。

複数のコントロールが文書に追加されると、各コントロールは、文書の ControlCollection のメンバになります。

ControlCollection クラスで使用できるメソッドを使用すると、ControlCollection にコントロールを追加したり、そのコントロールを削除したりできます。詳細については、「実行時の Office ドキュメントへのコントロールの追加」を参照してください。

例

次のコード例では、最初の段落にテキストを追加し、その段落を囲む Bookmark コントロールを作成します。この後、文書でのコントロールの総数を示すメッセージボックスを表示します。

このバージョンは、ドキュメントレベルのカスタマイズに使用されます。

Private Sub DocumentControls()
    Me.Paragraphs(1).Range.InsertParagraphAfter()
    Me.Paragraphs(1).Range.Text = "This is some sample text."
    Me.Controls.AddBookmark(Me.Paragraphs(1).Range, "Bookmark1")
    MessageBox.Show("Total number of controls: " & Me.Controls.Count.ToString())
End Sub

private void DocumentControls()
{
    this.Paragraphs[1].Range.InsertParagraphAfter();
    this.Paragraphs[1].Range.Text = "This is some sample text.";
    this.Controls.AddBookmark(this.Paragraphs[1].Range, "Bookmark1");
    MessageBox.Show("Total number of controls: " +
        this.Controls.Count.ToString());
}

このバージョンは、アプリケーションレベルのアドインに使用されます。

Private Sub DocumentControls()
    Dim vstoDoc As Document = Me.Application.ActiveDocument.GetVstoObject()
    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 = this.Application.ActiveDocument.GetVstoObject();
    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());
}