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

Article
09/25/2012

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

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

Syntax

'Declaration
Public Function AddRichTextBox ( _
    left As Double, _
    top As Double, _
    width As Double, _
    height As Double, _
    name As String _
) As RichTextBox

'Usage
Dim instance As ControlCollection 
Dim left As Double 
Dim top As Double 
Dim width As Double 
Dim height As Double 
Dim name As String 
Dim returnValue As RichTextBox 

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

public RichTextBox AddRichTextBox(
    double left,
    double top,
    double width,
    double height,
    string name
)

public:
RichTextBox^ AddRichTextBox(
    double left, 
    double top, 
    double width, 
    double height, 
    String^ name
)

public function AddRichTextBox(
    left : double, 
    top : double, 
    width : double, 
    height : double, 
    name : String
) : RichTextBox

Parameters

left
Type: System.Double

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

top
Type: System.Double

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

width
Type: System.Double

The width of the control in points.

height
Type: System.Double

The height of the control in points.

name
Type: System.String

The name of the control.

Return Value

Type: Microsoft.Office.Tools.Excel.Controls.RichTextBox
The RichTextBox 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

The AddRichTextBox method enables you to add RichTextBox objects to the end of the ControlCollection. To remove a RichTextBox control that was previously added programmatically, use the Remove method.

Examples

The following code example adds a RichTextBox control to the top of the worksheet, assigns text to the control, and then formats the text.

Private Sub ExcelRangeAddRichTextBox()

    Dim RichTextBox1 As Microsoft.Office.Tools. _
        Excel.Controls.RichTextBox = Me.Controls. _
        AddRichTextBox(Me.Range("A1", "B2"), _
        "RichTextBox1")

    RichTextBox1.Text = "Sample text"
    RichTextBox1.Select(0, 6)
    RichTextBox1.SelectionFont = New Font( _
        "Times New Roman", 10, FontStyle.Bold)

End Sub

private void ExcelRangeAddRichTextBox()
{

    Microsoft.Office.Tools.Excel.Controls.RichTextBox
         richTextBox1 = this.Controls.AddRichTextBox(
         this.Range["A1", "B2"], "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.

Share via