Document.Controls-Eigenschaft (2007 System)

  • Artikel

Aktualisiert: Juli 2008

Ruft die Auflistung aller Windows Forms-Steuerelemente und Hoststeuerelemente im Dokument ab.

Namespace:  Microsoft.Office.Tools.Word
Assembly:  Microsoft.Office.Tools.Word.v9.0 (in Microsoft.Office.Tools.Word.v9.0.dll)

Syntax

<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; }

Eigenschaftenwert

Typ: Microsoft.Office.Tools.Word.ControlCollection

Eine ControlCollection, die alle Windows Forms-Steuerelemente und Hoststeuerelemente im Dokument beinhaltet.

Hinweise

In einem Dokument, das Teil einer Anpassung auf Dokumentebene in Visual Studio Tools for Office ist, können Windows Forms-Steuerelemente und Hoststeuerelemente angezeigt werden. Weitere Informationen hierzu finden Sie unter Steuerelemente für Office-Dokumente.

Wenn einem Dokument mehrere Steuerelemente hinzugefügt werden, ist jedes der Steuerelemente ein Member der ControlCollection des Dokuments.

Sie können der ControlCollection Steuerelemente hinzufügen oder diese mithilfe der in der ControlCollection-Klasse verfügbaren Methoden entfernen. Weitere Informationen finden Sie unter Hinzufügen von Steuerelementen zu Office-Dokumenten zur Laufzeit.

Beispiele

Im folgenden Codebeispiel wird dem ersten Absatz Text hinzugefügt, und anschließend wird ein Bookmark-Steuerelement erstellt, das den Absatz enthält. Im Code wird dann ein Meldungsfeld mit der Gesamtzahl der Steuerelemente im Dokument angezeigt.

Diese Version bezieht sich auf eine Anpassung auf Dokumentebene.

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());
}

Diese Version bezieht sich auf ein Add-In auf Anwendungsebene.

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());
}

Berechtigungen

Siehe auch

Referenz

Document-Klasse

Document-Member

Microsoft.Office.Tools.Word-Namespace

Weitere Ressourcen

Steuerelemente für Office-Dokumente

Hinzufügen von Steuerelementen zu Office-Dokumenten zur Laufzeit

Änderungsprotokoll

Date

Versionsgeschichte

Grund

Juli 2008

Version des Codebeispiels für ein Add-In auf Anwendungsebene hinzugefügt.

SP1-Featureänderung.