ControlCollection.AddTextBox Method (, Single, Single, String) (2007 System)
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 ( _
range As Range, _
width As Single, _
height As Single, _
name As String _
) As TextBox
'Usage
Dim instance As ControlCollection
Dim range As Range
Dim width As Single
Dim height As Single
Dim name As String
Dim returnValue As TextBox
returnValue = instance.AddTextBox(range, _
width, height, name)
public TextBox AddTextBox(
Range range,
float width,
float height,
string name
)
public:
TextBox^ AddTextBox(
Range^ range,
float width,
float height,
String^ name
)
public function AddTextBox(
range : Range,
width : float,
height : float,
name : String
) : TextBox
Parameters
range
Type: RangeA Range that provides the location for the control.
width
Type: System.SingleThe width of the control in points.
height
Type: System.SingleThe height of the control in points.
name
Type: System.StringThe name that can be used to index the control in the ControlCollection instance.
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 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. |
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 first paragraph in the document, and then assigns text to the control.
Private Sub WordRangeAddTextBox()
Me.Paragraphs(1).Range.InsertParagraphBefore()
Dim TextBox1 As Microsoft.Office.Tools.Word.Controls. _
TextBox = Me.Controls.AddTextBox(Me.Paragraphs(1).Range, _
75, 15, "TextBox1")
TextBox1.Text = "Sample text"
End Sub
private void WordRangeAddTextBox()
{
this.Paragraphs[1].Range.InsertParagraphBefore();
Microsoft.Office.Tools.Word.Controls.TextBox
textBox1 = this.Controls.AddTextBox(
this.Paragraphs[1].Range, 75, 15, "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.