ControlCollection.AddTextBox Method (Double, Double, Double, Double, String) (2007 System)

  • Article

Adds a new TextBox control to the worksheet in the specified size and location.

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 ( _
    left As Double, _
    top As Double, _
    width As Double, _
    height As Double, _
    name As String _
) As TextBox

'Usage
Dim instance As ControlCollection 
Dim left As Double 
Dim top As Double 
Dim width As Double 
Dim height As Double 
Dim name As String 
Dim returnValue As TextBox 

returnValue = instance.AddTextBox(left, _
    top, width, height, name)

public TextBox AddTextBox(
    double left,
    double top,
    double width,
    double height,
    string name
)

public:
TextBox^ AddTextBox(
    double left, 
    double top, 
    double width, 
    double height, 
    String^ name
)

public function AddTextBox(
    left : double, 
    top : double, 
    width : double, 
    height : double, 
    name : String
) : TextBox

Parameters

  • left
    Type: System.Double

    The distance in points between the left edge of the control and the left edge of the worksheet.

  • top
    Type: System.Double

    The distance in points between the top edge of the control and the top edge of the worksheet.

  • height
    Type: System.Double

    The height of the control in points.

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 argument is nulla null reference (Nothing in Visual Basic) or has zero length.
ControlNameAlreadyExistsException

A control with the same name is already in the ControlCollection instance.

Remarks

The AddTextBox method enables you to add TextBox objects to the end of the ControlCollection. To remove a TextBox control that was previously added programmatically, use the Remove method.

Examples

The following code example adds a TextBox control to the top of the worksheet, and then assigns text to the control.

Private Sub ExcelAddTextBox()
    Dim TextBox1 As Microsoft.Office.Tools.Excel. _
        Controls.TextBox = Me.Controls.AddTextBox( _
        0, 0, 75, 15, "TextBox1")

    TextBox1.Text = "Sample text" 

End Sub

private void ExcelAddTextBox()
{
    Microsoft.Office.Tools.Excel.Controls.TextBox
         textBox1 = this.Controls.AddTextBox(
         0, 0, 75, 15, "textBox1");
    textBox1.Text = "Sample text";
}

.NET Framework Security

See Also

Reference

ControlCollection Class

ControlCollection Members

AddTextBox Overload

Microsoft.Office.Tools.Excel Namespace