Método ControlExtensions.AddRichTextBox (ControlCollection, Single, Single, Single, Single, String)

Artigo
01/09/2014

Adiciona um novo controle de RichTextBox o documento no tamanho e o local especificados.

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 AddRichTextBox ( _
    controls As ControlCollection, _
    left As Single, _
    top As Single, _
    width As Single, _
    height As Single, _
    name As String _
) As RichTextBox

public static RichTextBox AddRichTextBox(
    this ControlCollection controls,
    float left,
    float top,
    float width,
    float height,
    string name
)

Parâmetros

controls
Tipo: Microsoft.Office.Tools.Word.ControlCollection
A coleção para adicionar ao controle.Não fornecer este parâmetro você mesmo.Quando você chamar esse método retornar coleção Document.Controls propriedade (um nível do projeto) ou DocumentBase.Controls propriedade (um nível um documento projeto), este parâmetro estar fornecer automaticamente.

left
Tipo: System.Single
Os pontos a distância entre a borda esquerda de 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.

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 na instância de ControlCollection .

Valor de retorno

Tipo: Microsoft.Office.Tools.Word.Controls.RichTextBox
O controle que 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 em C#).

Exceções

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

Comentários

Esse método permite que você adicione objetos de RichTextBox ao final de ControlCollection.

Para remover RichTextBox que foi adicionado por meio de programação, use o método de Remove .

Exemplos

O exemplo de código a seguir adiciona um controle de RichTextBox para o início do documento, atribui o texto para o controle, e formatar o texto. Para usar este exemplo, ele execução da classe de ThisDocument em um projeto de um documento nível.

Private Sub WordAddRichTextBox()
    Me.Paragraphs(1).Range.InsertParagraphBefore()
    Dim RichTextBox1 As Microsoft.Office.Tools.Word.Controls. _
        RichTextBox = Me.Controls.AddRichTextBox(0, 0, 75, 15, _
        "RichTextBox1")
    RichTextBox1.Text = "Sample text"
    RichTextBox1.Select(0, 6)
    RichTextBox1.SelectionFont = New Font("Times New Roman", _
        10, FontStyle.Bold)
End Sub

private void WordAddRichTextBox()
{
    this.Paragraphs[1].Range.InsertParagraphBefore();
    Microsoft.Office.Tools.Word.Controls.RichTextBox
         richTextBox1 = this.Controls.AddRichTextBox(
        0, 0, 75, 15, "richTextBox1");
    richTextBox1.Text = "Sample text";
    richTextBox1.Select(0, 6);
    richTextBox1.SelectionFont = new Font("Times New Roman",
        10, FontStyle.Bold);
}

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ável.

Consulte também

Referência

ControlExtensions Classe

Sobrecargas AddRichTextBox

Namespace Microsoft.Office.Tools.Word

Compartilhar via