Método ControlExtensions.AddTextBox (ControlCollection, Range, String)

Artigo
01/09/2014

Adiciona um novo TextBox o controle para a planilha no intervalo especificado.

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

Sintaxe

'Declaração
<ExtensionAttribute> _
Public Shared Function AddTextBox ( _
    controls As ControlCollection, _
    range As Range, _
    name As String _
) As TextBox

public static TextBox AddTextBox(
    this ControlCollection controls,
    Range range,
    string name
)

Parâmetros

controls
Tipo: Microsoft.Office.Tools.Excel.ControlCollection
A coleção para adicionar o controle.Não forneça esse parâmetro por conta própria.Quando você chama esse método na coleção retornada com o Worksheet.Controls propriedade (em um projeto de nível de aplicativo) ou o WorksheetBase.Controls propriedade (em um projeto de nível de documento), este parâmetro é fornecido automaticamente.

range
Tipo: Microsoft.Office.Interop.Excel.Range
A Range que fornece os limites para o controle.

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

Valor de retorno

Tipo: Microsoft.Office.Tools.Excel.Controls.TextBox
O TextBox que foi adicionado ao controle de ControlCollection instância.

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 do nome ou a faixa é nulluma referência nula (Nothing no Visual Basic), ou o argumento nome tem comprimento zero.
ControlNameAlreadyExistsException	Um controle com o mesmo nome já está sendo o ControlCollection instância.
InvalidRangeException	O intervalo especificado não é válido. Intervalos de múltiplas áreas não podem ser usados. O intervalo deve estar na mesma planilha que o ControlCollection instância.

Comentários

O AddTextBox método permite que você adicione TextBox objetos no final da ControlCollection. Para remover um TextBox que foi previamente adicionado programaticamente, use o Remove método.

O controle é redimensionado automaticamente quando o intervalo é redimensionado.

Exemplos

O exemplo de código a seguir adiciona um TextBox controle às células A1 por meio de B2e, em seguida, atribui o texto para o controle. Para usar esse exemplo, executá-lo na Sheet1 classe em um projeto de nível de documento.

Private Sub ExcelRangeAddTextBox()
    Dim TextBox1 As Microsoft.Office.Tools.Excel. _
        Controls.TextBox = Me.Controls.AddTextBox( _
        Me.Range("A1", "B2"), "TextBox1")

    TextBox1.Text = "Sample text"

End Sub

private void ExcelRangeAddTextBox()
{
    Microsoft.Office.Tools.Excel.Controls.TextBox
         textBox1 = this.Controls.AddTextBox(
         this.Range["A1", "B2"], "textBox1");
    textBox1.Text = "Sample text";
}

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 AddTextBox

Namespace Microsoft.Office.Tools.Excel

Compartilhar via