Document.Controls A propriedade (sistema de 2007)

Artigo
08/25/2010

Obtém a coleção de todos os controles Windows Forms e controles de host que estão no documento.

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

Sintaxe

<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 propriedade

Tipo: Microsoft.Office.Tools.Word.ControlCollection
A ControlCollection que contém todos os controles Windows Forms e controles de host no documento.

Comentários

Um documento que faz parte de uma personalização em nível de documento em Visual Studio Tools for Office pode exibir controles Windows Forms e controles de host. Para obter mais informações, consulte Controles em documentos do Office.

Quando vários controles são adicionados a um documento, cada um dos controles é um membro do ControlCollection o documento.

Você pode adicionar controles à ControlCollection ou removê-los usando os métodos disponível na ControlCollection classe. 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 Bookmark controle que abrange o parágrafo. O código, em seguida, mostra uma caixa de mensagem exibe o número total de controles no documento.

Esta versão é para uma personalização em nível de documento.

PrivateSub 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())
EndSub

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

Esta versão é para um suplemento no nível de aplicativo.

PrivateSub 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())
EndSub

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

Permissões

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ódigos parcialmente Confiável.