RichTextString Class

Rich formatted text in a cell.

Namespace : DevExpress.Spreadsheet

Assembly : DevExpress.Spreadsheet.v25.2.Core.dll

NuGet Package : DevExpress.Spreadsheet.Core

Declaration

• C#
• VB.NET

public class RichTextString :
    IEquatable<RichTextString>

Public Class RichTextString
    Implements IEquatable(Of RichTextString)

Related API Members

The following members return RichTextString objects:

• CellRange.GetRichText()
• RichTextString.AddTextRun(String, RichTextRunFont)

Remarks

A cell in a worksheet may contain rich formatted text specified by the RichTextString object. Such rich text represents a cell text divided into one or more text regions (so-called text runs), each with its own set of font characteristics. An individual text run is defined by the RichTextRun object and is stored in the RichTextString.Runs collection.

To apply rich formatting to the cell text, do one of the following:

• Explicitly add text runs with the specified font settings to the rich text string using the RichTextString.AddTextRun method.
• Use the RichTextString.Characters method overloads to format specific characters within the cell text. These methods return the RichTextRange object that represents the specified text subset and allows you to set its font characteristics using the RichTextRange.Font property or RichTextRange.SetFont method.

Pass the RichTextString instance to the CellRange.SetRichText method to assign the specified rich text to a cell.

Use the CellRange.HasRichText property to check whether a cell contains rich formatted text. To retrieve rich text from a cell, use the CellRange.GetRichText method.

For more information on how to apply different fonts to specific regions of the cell text, refer to the How to: Apply Rich Formatting to Cell Text example.

Example

• C#
• VB.NET

// Create a RichTextString instance.
RichTextString richText = new RichTextString();

// Specify the cell text.
richText.Text = "Rich text formatting";
// Change font characteristics of the first word.
richText.Characters(0, 4).SetFont(new RichTextRunFont("Calibri", 12, System.Drawing.Color.Red));

// Assign the rich formatted text to the cell B2.
worksheet["B2"].SetRichText(richText);

' Create a RichTextString instance.
Dim richText As New RichTextString()

' Specify the cell text.
richText.Text = "Rich text formatting"
' Change font characteristics of the first word.
richText.Characters(0, 4).SetFont(New RichTextRunFont("Calibri", 12, System.Drawing.Color.Red))

' Assign the rich formatted text to the cell B2.
worksheet("B2").SetRichText(richText)

Implements

IEquatable<RichTextString>

Inheritance

Object RichTextString

See Also

RichTextString Members

AddTextRun(String, RichTextRunFont)

Characters

How to: Apply Rich Formatting to Cell Text

DevExpress.Spreadsheet Namespace