Método ControlExtensions.AddLabel (ControlCollection, Range, Single, Single, String)

Artigo
08/01/2011

Adiciona um novo Label o controle para o documento em que o tamanho especificado e o local.

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

Sintaxe

'Declaração
<ExtensionAttribute> _
Public Shared Function AddLabel ( _
    controls As ControlCollection, _
    range As Range, _
    width As Single, _
    height As Single, _
    name As String _
) As Label

public static Label AddLabel(
    this ControlCollection controls,
    Range range,
    float width,
    float height,
    string name
)

Parâmetros

controls
Tipo: Microsoft.Office.Tools.Word.ControlCollection
A coleção para adicionar o controle.Não forneça esse parâmetro sozinho.Quando você chamar esse método na coleção retornada com o Document.Controls propriedade (em um projeto de nível de aplicativo) ou o DocumentBase.Controls propriedade (em um projeto de nível de documento), este parâmetro é fornecido automaticamente.

range
Tipo: Microsoft.Office.Interop.Word.Range
O local do controle.

width
Tipo: System.Single
A largura do controle em pontos.

height
Tipo: System.Single
A altura do controle em pontos.

name
Tipo: System.String
O nome que pode ser usado para indexar o controle de ControlCollection instância.

Valor de retorno

Tipo: Microsoft.Office.Tools.Word.Controls.Label
O controle foi adicionado ao documento.

Observação de uso

No Visual Basic e no C#, você pode chamar esse método como um método de instância em qualquer objeto do tipo ControlCollection. Quando você usar a sintaxe de método de instância para chamar esse método, omita o primeiro parâmetro. Para obter mais informações, consulte Métodos de extensão (Visual Basic) ou Métodos de extensão (guia de programação TRANSLATION FROM VPE FOR CSHARP).

Exceções

Exceção	Condição
ArgumentNullException	O name ou range argumento é nulluma referência nula (Nothing no Visual Basic), ou o name argumento tem comprimento zero.
ControlNameAlreadyExistsException	Um controle com o mesmo nome já está na ControlCollection instância.
InvalidRangeException	O intervalo especificado não é válido.

Comentários

Esse método permite que você adicione Label objetos no final da ControlCollection.

Para remover um Label que foi adicionado programaticamente, use o Remove método.

Exemplos

O exemplo de código a seguir adiciona um Label ao primeiro parágrafo no documento e as alterações, em seguida, o texto de controle para nome. Para usar esse exemplo, executá-lo do ThisDocument a classe em um projeto de nível de documento.

Private Sub WordRangeAddLabel()
    Me.Paragraphs(1).Range.InsertParagraphBefore()
    Dim Label1 As Microsoft.Office.Tools.Word.Controls.Label _
        = Me.Controls.AddLabel(Me.Paragraphs(1).Range, 75, _
            17.25F, "Label1")
    Label1.Text = "First Name"
End Sub

private void WordRangeAddLabel()
{
    this.Paragraphs[1].Range.InsertParagraphBefore();
    Microsoft.Office.Tools.Word.Controls.Label
        label1 = this.Controls.AddLabel(
        this.Paragraphs[1].Range, 75, 17.25F, "label1");
    label1.Text = "First Name";
}

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.

Consulte também

Referência

ControlExtensions Classe

Sobrecargas AddLabel

Namespace Microsoft.Office.Tools.Word

Partilhar via