ControlExtensions.AddRichTextBox Method

Reference

Definition

Namespace:: Microsoft.Office.Tools.Word

Assembly:: Microsoft.Office.Tools.Word.v4.0.Utilities.dll

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

AddRichTextBox(ControlCollection, Range, Single, Single, String)	Adds a new RichTextBox control to the document in the specified size and location.
AddRichTextBox(ControlCollection, Single, Single, Single, Single, String)	Adds a new RichTextBox control to the document in the specified size and location.

AddRichTextBox(ControlCollection, Range, Single, Single, String)

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

public:
[System::Runtime::CompilerServices::Extension]
 static Microsoft::Office::Tools::Word::Controls::RichTextBox ^ AddRichTextBox(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.RichTextBox AddRichTextBox (this Microsoft.Office.Tools.Word.ControlCollection controls, Microsoft.Office.Interop.Word.Range range, float width, float height, string name);

static member AddRichTextBox : Microsoft.Office.Tools.Word.ControlCollection * Microsoft.Office.Interop.Word.Range * single * single * string -> Microsoft.Office.Tools.Word.Controls.RichTextBox

<Extension()>
Public Function AddRichTextBox (controls As ControlCollection, range As Range, width As Single, height As Single, name As String) As RichTextBox

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

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

RichTextBox

The control that was added to the document.

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.

Examples

The following code example adds a RichTextBox control to the first paragraph in the document, assigns text to the control, and then formats the text. To use this example, run it from the ThisDocument class in a document-level project.

private void WordRangeAddRichTextBox()
{
    this.Paragraphs[1].Range.InsertParagraphBefore();
    Microsoft.Office.Tools.Word.Controls.RichTextBox
         richTextBox1 = this.Controls.AddRichTextBox(
         this.Paragraphs[1].Range, 75, 15, "richTextBox1");
    richTextBox1.Text = "Sample text";
    richTextBox1.Select(0, 6);
    richTextBox1.SelectionFont = new Font("Times New Roman",
        10, FontStyle.Bold);
}

Private Sub WordRangeAddRichTextBox()
    Me.Paragraphs(1).Range.InsertParagraphBefore()
    Dim RichTextBox1 As Microsoft.Office.Tools.Word.Controls. _
        RichTextBox = Me.Controls.AddRichTextBox( _
        Me.Paragraphs(1).Range, 75, 15, "RichTextBox1")
    RichTextBox1.Text = "Sample text"
    RichTextBox1.Select(0, 6)
    RichTextBox1.SelectionFont = New Font("Times New Roman", _
        10, FontStyle.Bold)
End Sub

Remarks

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

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

Applies to

AddRichTextBox(ControlCollection, Single, Single, Single, Single, String)

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

public:
[System::Runtime::CompilerServices::Extension]
 static Microsoft::Office::Tools::Word::Controls::RichTextBox ^ AddRichTextBox(Microsoft::Office::Tools::Word::ControlCollection ^ controls, float left, float top, float width, float height, System::String ^ name);

public static Microsoft.Office.Tools.Word.Controls.RichTextBox AddRichTextBox (this Microsoft.Office.Tools.Word.ControlCollection controls, float left, float top, float width, float height, string name);

static member AddRichTextBox : Microsoft.Office.Tools.Word.ControlCollection * single * single * single * single * string -> Microsoft.Office.Tools.Word.Controls.RichTextBox

<Extension()>
Public Function AddRichTextBox (controls As ControlCollection, left As Single, top As Single, width As Single, height As Single, name As String) As RichTextBox

Parameters

controls: ControlCollection

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

RichTextBox

The control that was added to the document.

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 RichTextBox control to the start of the document, assigns text to the control, and then formats the text. To use this example, run it from the ThisDocument class in a document-level project.

private void WordAddRichTextBox()
{
    this.Paragraphs[1].Range.InsertParagraphBefore();
    Microsoft.Office.Tools.Word.Controls.RichTextBox
         richTextBox1 = this.Controls.AddRichTextBox(
        0, 0, 75, 15, "richTextBox1");
    richTextBox1.Text = "Sample text";
    richTextBox1.Select(0, 6);
    richTextBox1.SelectionFont = new Font("Times New Roman",
        10, FontStyle.Bold);
}

Private Sub WordAddRichTextBox()
    Me.Paragraphs(1).Range.InsertParagraphBefore()
    Dim RichTextBox1 As Microsoft.Office.Tools.Word.Controls. _
        RichTextBox = Me.Controls.AddRichTextBox(0, 0, 75, 15, _
        "RichTextBox1")
    RichTextBox1.Text = "Sample text"
    RichTextBox1.Select(0, 6)
    RichTextBox1.SelectionFont = New Font("Times New Roman", _
        10, FontStyle.Bold)
End Sub

Remarks

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

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

Applies to

Share via

ControlExtensions.AddRichTextBox Method

Definition

Overloads

AddRichTextBox(ControlCollection, Range, Single, Single, String)

Parameters

Returns

Exceptions

Examples

Remarks

Applies to

AddRichTextBox(ControlCollection, Single, Single, Single, Single, String)

Parameters

Returns

Exceptions

Examples

Remarks

Applies to

Additional resources