ShapeCollection.AddTextBox(CellRange, String) Method

Inserts a text box to fit in the specified range.

Namespace: DevExpress.Spreadsheet

Assembly: DevExpress.Spreadsheet.v24.1.Core.dll

NuGet Package: DevExpress.Spreadsheet.Core

Declaration

C#

Shape AddTextBox(
    CellRange targetRange,
    string text
)

VB.NET

Function AddTextBox(
    targetRange As CellRange,
    text As String
) As Shape

Parameters

Name	Type	Description
targetRange	CellRange	A cell range to which the inserted text box should fit.
text	String	The text box’s content.

Returns

Type	Description
Shape	The resulting text box.

Remarks

The following properties help you determine whether the current Shape object is a text box:

• The Shape.ShapeType property is ShapeType.Shape.
• The ShapeGeometry.Preset property returns ShapeGeometryPreset.Rectangle.
• The ShapeText.HasText property is true.

Use the ShapeFormatBase.Fill and ShapeFormatBase.Outline properties to change the text box’s fill and outline settings. The Shape.ShapeText property provides access to the shape’s text options.

To delete a text box, use the ShapeCollection.RemoveAt or Shape.Delete method.