Document.Controls, propriété (System 2007)

Article
09/04/2008

Mise à jour : Juillet 2008

Obtient la collection de tous les contrôles Windows Forms et contrôles hôtes qui se trouvent dans le document.

Espace de noms : Microsoft.Office.Tools.Word
Assembly : Microsoft.Office.Tools.Word.v9.0 (dans Microsoft.Office.Tools.Word.v9.0.dll)

Syntaxe

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

Valeur de propriété

Type : Microsoft.Office.Tools.Word.ControlCollection

ControlCollection qui contient tous les contrôles Windows Forms et les contrôles hôtes du document.

Notes

Un document qui fait partie d'une personnalisation au niveau du document dans Visual Studio Tools pour Officepeut afficher des contrôles Windows Forms et des contrôles hôtes. Pour plus d'informations, consultez Contrôles sur des documents Office.

Lorsque plusieurs contrôles sont ajoutés à un document, chacun des contrôles est membre du ControlCollection du document.

Vous pouvez ajouter des contrôles à ControlCollection ou les supprimer en utilisant les méthodes disponibles dans la classe ControlCollection. Pour plus d'informations, consultez Ajout de contrôles à des documents Office au moment de l'exécution.

Exemples

L'exemple de code suivant ajoute du texte au premier paragraphe et crée un contrôle Bookmark qui englobe le paragraphe. Le code affiche ensuite un message qui indique le nombre total de contrôles dans le document.

Cette version est destinée à une personnalisation au niveau du document.

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

Cette version est destinée à un complément d'application.

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

Autorisations

Confiance totale accordée à l'appelant immédiat. Ce membre ne peut pas être utilisé par du code d'un niveau de confiance partiel. Pour plus d'informations, consultez Utilisation de bibliothèques à partir de code d'un niveau de confiance partiel.