ControlCollection.AddTextBox Method (, String) (2007 System)
Adds a new TextBox control to the worksheet at the range specified.
Namespace: Microsoft.Office.Tools.Excel
Assembly: Microsoft.Office.Tools.Excel.v9.0 (in Microsoft.Office.Tools.Excel.v9.0.dll)
Syntax
'Declaration
Public Function AddTextBox ( _
range As Range, _
name As String _
) As TextBox
'Usage
Dim instance As ControlCollection
Dim range As Range
Dim name As String
Dim returnValue As TextBox
returnValue = instance.AddTextBox(range, _
name)
public TextBox AddTextBox(
Range range,
string name
)
public:
TextBox^ AddTextBox(
Range^ range,
String^ name
)
public function AddTextBox(
range : Range,
name : String
) : TextBox
Parameters
range
Type: RangeA Range that provides the bounds for the control.
name
Type: System.StringThe name of the control that can be used to index the control in the ControlCollection instance.
Return Value
Type: Microsoft.Office.Tools.Excel.Controls.TextBox
The TextBox control that was added to the ControlCollection instance.
Exceptions
Exception | Condition |
---|---|
ArgumentNullException | The name or range argument is nulla null reference (Nothing in Visual Basic), or the name argument has zero length. |
ControlNameAlreadyExistsException | A control with the same name is already in the ControlCollection instance. |
InvalidRangeException | The range that was specified is not valid. Multi-area ranges cannot be used. The range should be on the same worksheet as the ControlCollection instance. |
Remarks
The AddTextBox method enables you to add TextBox objects to the end of the ControlCollection. To remove a TextBox that was previously added programmatically, use the Remove method.
The control automatically resizes when the range is resized.
Examples
The following code example adds a TextBox control to cells A1 through B2, and then assigns text to the control.
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";
}
.NET Framework Security
- Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.