ControlExtensions.AddTextBox (Método) (ControlCollection, Range, String)
Agrega a la hoja de cálculo un nuevo control TextBox en el rango especificado.
Espacio de nombres: Microsoft.Office.Tools.Excel
Ensamblado: Microsoft.Office.Tools.Excel.v4.0.Utilities (en Microsoft.Office.Tools.Excel.v4.0.Utilities.dll)
Sintaxis
'Declaración
<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
Colección a la que se va a agregar el control.No proporcione este parámetro personalmente.Cuando se llama a este método en la colección devuelta por la propiedad Worksheet.Controls (en un proyecto de nivel de aplicación) o la propiedad WorksheetBase.Controls (en un proyecto de nivel de documento), este parámetro se proporciona automáticamente.
- range
Tipo: Microsoft.Office.Interop.Excel.Range
Objeto Range que proporciona los límites del control.
- name
Tipo: System.String
Nombre del control que puede utilizarse para indizar el control en la instancia de ControlCollection.
Valor devuelto
Tipo: Microsoft.Office.Tools.Excel.Controls.TextBox
Control TextBox agregado a la instancia del objeto ControlCollection.
Nota sobre el uso
En Visual Basic y C#, se puede llamar a este método como a un método de instancia en cualquier objeto de tipo ControlCollection. Cuando emplee la sintaxis del método de instancia para llamar a este método, omita el primer parámetro. Para obtener más información, vea Métodos de extensión (Visual Basic) o Métodos de extensión (Guía de programación de C#).
Excepciones
| Excepción | Condición |
|---|---|
| ArgumentNullException | El argumento de nombre o rango es nullreferencia null (Nothing en Visual Basic), o el argumento de nombre tiene longitud cero. |
| ControlNameAlreadyExistsException | Ya existe un control con el mismo nombre en la instancia de ControlCollection. |
| InvalidRangeException | El intervalo especificado no es válido. No pueden utilizarse rangos multiárea. El rango debe estar en la misma hoja de cálculo que la instancia de ControlCollection. |
Comentarios
El método AddTextBox permite agregar objetos TextBox al final de ControlCollection. Para quitar un control TextBox agregado previamente mediante programación, utilice el método Remove.
El control cambia de tamaño automáticamente cada vez que cambia el tamaño del rango.
Ejemplos
En el siguiente ejemplo de código se agrega un control TextBox a las celdas A1 hasta B2 y, a continuación, se asigna texto al control. Para usar este ejemplo, ejecútelo desde la clase Sheet1 en un proyecto de nivel 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";
}
Seguridad de .NET Framework
- Plena confianza para el llamador inmediato. Un código de confianza parcial no puede utilizar este miembro. Para obtener más información, vea Utilizar bibliotecas de código que no es de plena confianza.