ShapeText.Characters(Int32) Method

Namespace: DevExpress.Spreadsheet

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

Declaration

ShapeTextRange Characters(
    int start
)

Function Characters(
    start As Integer
) As ShapeTextRange

Parameters

Returns

Remarks

Call the Characters method to format a specific text range within the shape text. The Characters property returns a ShapeTextRange object representing a text range. Specify the shape’s text using the RichTextRange.Text property.

You can change the retrieved range’s font settings using the ShapeTextRange.Font property. The ShapeTextRange.ParagraphFormat property provides access to the range’s paragraph properties. When you use the Characters method to insert new text to the range, this text has the same font and paragraph properties as the existing content.

Call the ShapeTextRange.AddBefore or ShapeTextRange.AddAfter method to insert a new text range before of after the retrieved ShapeTextRange object. The ShapeTextRange.GetRuns method returns all text ranges in the shape text.

Call the ShapeTextRange.Delete method to delete the ShapeTextRange object.

Refer to the How to: Add Text to a Shape topic for an example of how to create a shape text.