Propriedade Document.Controls

Artigo
05/21/2013

Obtém a coleção de controles gerenciados que estão contidos no documento.

Namespace: Microsoft.Office.Tools.Word
Assemblies: Microsoft.Office.Tools.Word.v4.0.Utilities (em Microsoft.Office.Tools.Word.v4.0.Utilities.dll)
Microsoft.Office.Tools.Word (em Microsoft.Office.Tools.Word.dll)

Sintaxe

'Declaração
ReadOnly Property Controls As ControlCollection

ControlCollection Controls { get; }

Valor de propriedade

Tipo: Microsoft.Office.Tools.Word.ControlCollection
ControlCollection que contém todos os controles gerenciados no documento.

Comentários

Um documento em uma solução do Office pode conter controles de formulários do Windows e controles host.Para obter mais informações, consulte Controles em documentos do Office.

Para gerenciar em tempo de execução os controles em um documento, use os métodos e propriedades do objeto de ControlCollection retornado pela propriedade de Controls .Para obter mais informações, consulte Adicionar controles a documentos do Office em tempo de execução.

Exemplos

O exemplo de código a seguir adiciona texto ao primeiro parágrafo e cria um controle de Bookmark que abrange o parágrafo.O código a seguir mostra em uma caixa de mensagem que exibe o número total de controles no documento.Este exemplo é para um suplemento ao aplicativo.

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

Segurança do .NET Framework

Confiança total para o chamador imediato. O membro não pode ser usado por código parcialmente confiável. Para obter mais informações, consulte Usando bibliotecas de código parcialmente confiáveis.