Document.Controls (Propiedad)

Artículo
08/10/2011

Obtiene la colección de controles administrados contenidos en el documento.

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

Sintaxis

'Declaración
ReadOnly Property Controls As ControlCollection
    Get

ControlCollection Controls { get; }

Valor de propiedad

Tipo: Microsoft.Office.Tools.Word.ControlCollection
Una colección ControlCollection que contiene todos los controles administrados en el documento.

Comentarios

Un documento en una solución de Office puede contener controles de Windows Forms y controles de host. Para obtener más información, vea Controles en documentos de Office.

Para administrar los controles en un documento en tiempo de ejecución, use los métodos y propiedades del objeto ControlCollection devueltos por la propiedad Controls. 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 un ejemplo para un complemento en el nivel de la aplicación.

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

Seguridad de .NET Framework

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.