ControlExtensions.AddTextBox Method

Definition

Namespace:

Microsoft.Office.Tools.Excel

Assembly:

Microsoft.Office.Tools.Excel.v4.0.Utilities.dll

Overloads

AddTextBox(ControlCollection, Range, String)	Adds a new TextBox control to the worksheet at the range specified.
AddTextBox(ControlCollection, Double, Double, Double, Double, String)	Adds a new TextBox control to the worksheet in the specified size and location.

AddTextBox(ControlCollection, Range, String)

Adds a new TextBox control to the worksheet at the range specified.

public:
[System::Runtime::CompilerServices::Extension]
 static Microsoft::Office::Tools::Excel::Controls::TextBox ^ AddTextBox(Microsoft::Office::Tools::Excel::ControlCollection ^ controls, Microsoft::Office::Interop::Excel::Range ^ range, System::String ^ name);

public static Microsoft.Office.Tools.Excel.Controls.TextBox AddTextBox (this Microsoft.Office.Tools.Excel.ControlCollection controls, Microsoft.Office.Interop.Excel.Range range, string name);

static member AddTextBox : Microsoft.Office.Tools.Excel.ControlCollection * Microsoft.Office.Interop.Excel.Range * string -> Microsoft.Office.Tools.Excel.Controls.TextBox

<Extension()>
Public Function AddTextBox (controls As ControlCollection, range As Range, name As String) As TextBox

Parameters

controls

ControlCollection

The collection to add the control to. Do not supply this parameter yourself. When you call this method on the collection returned by the Controls property (in an application-level project) or the Controls property (in a document-level project), this parameter is supplied automatically.

range

Range

A Range that provides the bounds for the control.

name

String

The name of the control that can be used to index the control in the ControlCollection instance.

Returns

TextBox

The TextBox control that was added to the ControlCollection instance.

Exceptions

ArgumentNullException

The name or range argument is null, 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.

Examples

The following code example adds a TextBox control to cells A1 through B2, and then assigns text to the control. To use this example, run it from the Sheet1 class in a document-level project.

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

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

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.

AddTextBox(ControlCollection, Double, Double, Double, Double, String)

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

public:
[System::Runtime::CompilerServices::Extension]
 static Microsoft::Office::Tools::Excel::Controls::TextBox ^ AddTextBox(Microsoft::Office::Tools::Excel::ControlCollection ^ controls, double left, double top, double width, double height, System::String ^ name);

public static Microsoft.Office.Tools.Excel.Controls.TextBox AddTextBox (this Microsoft.Office.Tools.Excel.ControlCollection controls, double left, double top, double width, double height, string name);

static member AddTextBox : Microsoft.Office.Tools.Excel.ControlCollection * double * double * double * double * string -> Microsoft.Office.Tools.Excel.Controls.TextBox

<Extension()>
Public Function AddTextBox (controls As ControlCollection, left As Double, top As Double, width As Double, height As Double, name As String) As TextBox

Parameters

controls

ControlCollection

The collection to add the control to. Do not supply this parameter yourself. When you call this method on the collection returned by the Controls property (in an application-level project) or the Controls property (in a document-level project), this parameter is supplied automatically.

left

Double

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

top

Double

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

width

Double

The width of the control in points.

height

Double

The height of the control in points.

name

String

The name of the control.

Returns

TextBox

The TextBox control that was added to the ControlCollection instance.

Exceptions

ArgumentNullException

The name argument is null or has zero length.

ControlNameAlreadyExistsException

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

Examples

The following code example adds a TextBox control to the top of the worksheet, and then assigns text to the control. To use this example, run it from the Sheet1 class in a document-level project.

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

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

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.