Compartilhar via

Método ControlCollection.AddControl (Control, Single, Single, Single, Single, String)

  • Artigo

Adicionar o controle a ControlCollection especificado no local especificado, com o tamanho especificado.

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

Sintaxe

'Declaração
Function AddControl ( _
    control As Control, _
    left As Single, _
    top As Single, _
    width As Single, _
    height As Single, _
    name As String _
) As ControlSite

ControlSite AddControl(
    Control control,
    float left,
    float top,
    float width,
    float height,
    string name
)

Parâmetros

  • left
    Tipo: System.Single
    Os pontos a distância entre a borda esquerda do controle e a borda esquerda do documento.
  • top
    Tipo: System.Single
    Os pontos a distância entre a borda superior do controle e a borda superior do documento.

Valor de retorno

Tipo: Microsoft.Office.Tools.Word.ControlSite
Um objeto que representa o controle que contém o controle específico no documento.

Exceções

Exceção Condição
ArgumentNullException

O argumento de name é nulluma referência nula (Nothing no Visual Basic), ou o argumento de name tem comprimento zero.
ControlNameAlreadyExistsException

Um controle com o mesmo nome já está na instância de ControlCollection .
ControlCouldNotBeInitializedException

O argumento de control é nulluma referência nula (Nothing no Visual Basic).

Comentários

Esse método pode ser usado para adicionar em tempo de execução qualquer controle a ControlCollection .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 dois controles de usuário personalizados para o documento usando o método de AddControl .O primeiro controle é adicionado a Range.O segundo controle é adicionado a um local específico.O código altera a propriedade de Top do primeiro controle de usuário personalizados, que move somente o controle em relação a ControlSite que contém o controle no documento.O código define a propriedade de Top de ControlSite retornado pelo segundo controle de usuário para ilustrar a maneira correta de definir a propriedade de Top do controle.

Private Sub WordRangeAddControl()
    Me.Paragraphs(1).Range.InsertParagraphBefore()
    Dim CustomUserControl As New UserControl1()
    Dim CustomUserControl2 As New UserControl2()

    Dim DynamicControl As Microsoft.Office.Tools.Word.ControlSite = _
        Me.Controls.AddControl(CustomUserControl, _
        Me.Paragraphs(1).Range, 150, 150, "DynamicControl")

    Dim DynamicControl2 As Microsoft.Office.Tools.Word.ControlSite = _
        Me.Controls.AddControl(CustomUserControl2, _
        200, 0, 150, 150, "DynamicControl2")

    CustomUserControl.BackColor = Color.Blue
    CustomUserControl2.BackColor = Color.Green

    CustomUserControl.Top = 100
    dynamicControl2.Top = 100
End Sub 

private void WordRangeAddControl()
{
    this.Paragraphs[1].Range.InsertParagraphBefore();
    UserControl1 customUserControl = new UserControl1();
    UserControl2 customUserControl2 = new UserControl2();

    Microsoft.Office.Tools.Word.ControlSite dynamicControl =
        this.Controls.AddControl(customUserControl, 
        this.Paragraphs[1].Range, 150, 150, "dynamicControl");

    Microsoft.Office.Tools.Word.ControlSite dynamicControl2 =
        this.Controls.AddControl(customUserControl2, 200, 0,
        150, 150, "dynamicControl2");

    customUserControl.BackColor = Color.Blue;
    customUserControl2.BackColor = Color.Green;

    customUserControl.Top = 100;
    dynamicControl2.Top = 100;
}

Segurança do .NET Framework

Consulte também

Referência

ControlCollection Interface

Sobrecargas AddControl

Namespace Microsoft.Office.Tools.Word