Document.Controls (Propiedad) (2007 System)

Artículo
09/04/2008

Actualización: Julio de 2008

Obtiene la colección de todos los controles de formularios Windows Forms y controles host que están en el documento.

Espacio de nombres: Microsoft.Office.Tools.Word
Ensamblado: Microsoft.Office.Tools.Word.v9.0 (en Microsoft.Office.Tools.Word.v9.0.dll)

Sintaxis

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

Valor de propiedad

Tipo: Microsoft.Office.Tools.Word.ControlCollection

ControlCollection que contiene todos los controles de formularios Windows Forms y controles host en el documento.

Comentarios

Un documento que forma parte de una personalización de nivel de documento en Visual Studio Tools para Office puede mostrar controles de formularios Windows Forms y controles host. Para obtener más información, vea Controles en documentos de Office.

Cuando se agregan varios controles a un documento, cada uno de los controles es un miembro de la colección ControlCollection del documento.

Puede agregar controles a ControlCollection o quitarlos utilizando los métodos disponibles en ControlCollection. Para obtener más información, vea Agregar controles a documentos de Office en tiempo de ejecución.

Ejemplos

En el ejemplo de código siguiente se agrega texto al primer párrafo y se crea un control Bookmark que abarca el párrafo. A continuación, el código muestra un cuadro de mensaje que proporciona el número total de controles del documento.

Se trata de una versión para una personalización en el nivel del documento.

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

Se trata de una versión para un complemento en el nivel de la aplicación.

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

Permisos

Plena confianza para el llamador inmediato. Un código de confianza parcial no puede utilizar este miembro. Para obtener más información, vea Utilizar bibliotecas de código que no es de plena confianza.