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

Adds a new RichTextBox 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 AddRichTextBox ( _
    range As Range, _
    width As Single, _
    height As Single, _
    name As String _
) As RichTextBox

'Usage
Dim instance As ControlCollection 
Dim range As Range 
Dim width As Single 
Dim height As Single 
Dim name As String 
Dim returnValue As RichTextBox 

returnValue = instance.AddRichTextBox(range, _
    width, height, name)

public RichTextBox AddRichTextBox(
    Range range,
    float width,
    float height,
    string name
)

public:
RichTextBox^ AddRichTextBox(
    Range^ range, 
    float width, 
    float height, 
    String^ name
)

public function AddRichTextBox(
    range : Range, 
    width : float, 
    height : float, 
    name : String
) : RichTextBox

Parameters

• range
  Type: Range

  A Range that provides the location for the control.

• width
  Type: System.Single

  The width of the control in points.

• height
  Type: System.Single

  The height of the control in points.

• name
  Type: System.String

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

Return Value

Type: Microsoft.Office.Tools.Word.Controls.RichTextBox
The RichTextBox control that was added to the ControlCollection instance.

Exceptions

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.

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.

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

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);
}

.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.

See Also

Reference

ControlCollection Class

ControlCollection Members

AddRichTextBox Overload

Microsoft.Office.Tools.Word Namespace