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

  • Article

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

Namespace:  Microsoft.Office.Tools.Word
Assembly:  Microsoft.Office.Tools.Word.v9.0 (in Microsoft.Office.Tools.Word.v9.0.dll)

Syntax

'Declaration
Public Function AddTextBox ( _
    left As Single, _
    top As Single, _
    width As Single, _
    height As Single, _
    name As String _
) As TextBox

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

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

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

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

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

Parameters

  • left
    Type: System.Single

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

  • top
    Type: System.Single

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

  • height
    Type: System.Single

    The height of the control in points.

Return Value

Type: Microsoft.Office.Tools.Word.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

This method enables you to add TextBox objects to the end of the ControlCollection.

To remove a TextBox that was added programmatically, use the Remove method.

Examples

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

Private Sub WordAddTextBox()
    Me.Paragraphs(1).Range.InsertParagraphBefore()
    Dim TextBox1 As Microsoft.Office.Tools.Word.Controls. _
        TextBox = Me.Controls.AddTextBox(0, 0, 75, 15, _
        "TextBox1")
    TextBox1.Text = "Sample text" 

End Sub

private void WordAddTextBox()
{
    this.Paragraphs[1].Range.InsertParagraphBefore();
    Microsoft.Office.Tools.Word.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.Word Namespace