ControlExtensions.AddTextBox Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| AddTextBox(ControlCollection, Range, Single, Single, String) |
Adds a new TextBox control to the document in the specified size and location. |
| AddTextBox(ControlCollection, Single, Single, Single, Single, String) |
Adds a new TextBox control to the document in the specified size and location. |
AddTextBox(ControlCollection, Range, Single, Single, String)
Adds a new TextBox control to the document in the specified size and location.
public:
[System::Runtime::CompilerServices::Extension]
static Microsoft::Office::Tools::Word::Controls::TextBox ^ AddTextBox(Microsoft::Office::Tools::Word::ControlCollection ^ controls, Microsoft::Office::Interop::Word::Range ^ range, float width, float height, System::String ^ name);public static Microsoft.Office.Tools.Word.Controls.TextBox AddTextBox (this Microsoft.Office.Tools.Word.ControlCollection controls, Microsoft.Office.Interop.Word.Range range, float width, float height, string name);static member AddTextBox : Microsoft.Office.Tools.Word.ControlCollection * Microsoft.Office.Interop.Word.Range * single * single * string -> Microsoft.Office.Tools.Word.Controls.TextBox<Extension()>
Public Function AddTextBox (controls As ControlCollection, range As Range, width As Single, height As Single, name As String) As TextBoxParameters
- 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
The location of the control.
- width
- Single
The width of the control in points.
- height
- Single
The height of the control in points.
- name
- String
The name that can be used to index the control in the ControlCollection instance.
Returns
The control that was added to the document.
Exceptions
The name or range argument is null, or the name argument has zero length.
A control with the same name is already in the ControlCollection instance.
The range that was specified is not valid.
Examples
The following code example adds a TextBox control to the first paragraph in the document, and then assigns text to the control. To use this example, run it from the ThisDocument class in a document-level project.
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";
}
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
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.
Applies to
AddTextBox(ControlCollection, Single, Single, Single, Single, String)
Adds a new TextBox control to the document in the specified size and location.
public:
[System::Runtime::CompilerServices::Extension]
static Microsoft::Office::Tools::Word::Controls::TextBox ^ AddTextBox(Microsoft::Office::Tools::Word::ControlCollection ^ controls, float left, float top, float width, float height, System::String ^ name);public static Microsoft.Office.Tools.Word.Controls.TextBox AddTextBox (this Microsoft.Office.Tools.Word.ControlCollection controls, float left, float top, float width, float height, string name);static member AddTextBox : Microsoft.Office.Tools.Word.ControlCollection * single * single * single * single * string -> Microsoft.Office.Tools.Word.Controls.TextBox<Extension()>
Public Function AddTextBox (controls As ControlCollection, left As Single, top As Single, width As Single, height As Single, name As String) As TextBoxParameters
- 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
- Single
The distance in points between the left edge of the control and the left edge of the document.
- top
- Single
The distance in points between the top edge of the control and the top edge of the document.
- width
- Single
The width of the control in points.
- height
- Single
The height of the control in points.
- name
- String
The name that can be used to index the control in the ControlCollection instance.
Returns
The control that was added to the document.
Exceptions
The name argument is null or has zero length.
A control with the same name is already in the ControlCollection instance.
Examples
The following code example adds a TextBox control to the start of the document, and then assigns text to the control. To use this example, run it from the ThisDocument class in a document-level project.
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";
}
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
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.