XlRichTextRun Class

Represents a region of the cell text with its own set of font characteristics.

Namespace: DevExpress.Export.Xl

Assembly: DevExpress.Printing.v24.2.Core.dll

Declaration

C#

public class XlRichTextRun

VB.NET

Public Class XlRichTextRun

Remarks

A cell in a worksheet may contain a rich formatted text (XlRichTextString) grouped into one or more runs. Each run is specified by the XlRichTextRun object and defines a region of the cell text (XlRichTextRun.Text) with its own set of font characteristics (XlRichTextRun.Font). The XlRichTextString.Runs property provides access to the collection that stores text runs. Use the collection’s methods to divide the cell text into regions and specify font settings for each text region. For details, refer to the How to: Apply Rich Formatting to the Cell Text example.

Example

Note

A complete sample project is available at https://github.com/DevExpress-Examples/excel-export-api-examples

CellFormattingActions.cs

// Create a new worksheet.
using (IXlSheet sheet = document.CreateSheet())
{
    // Create the first column and set its width.
    using (IXlColumn column = sheet.CreateColumn())
    {
        column.WidthInPixels = 180;
    }
    // Create the first row.
    using (IXlRow row = sheet.CreateRow())
    {
        // Create the cell A1.
        using (IXlCell cell = row.CreateCell())
        {
            // Create an XlRichTextString instance.
            XlRichTextString richText = new XlRichTextString();
            // Add three text runs to the collection. 
            richText.Runs.Add(new XlRichTextRun("Formatted ", XlFont.CustomFont("Arial", 14.0, XlColor.FromArgb(0x53, 0xbb, 0xf4))));
            richText.Runs.Add(new XlRichTextRun("cell ", XlFont.CustomFont("Century Gothic", 14.0, XlColor.FromArgb(0xf1, 0x77, 0x00))));
            richText.Runs.Add(new XlRichTextRun("text", XlFont.CustomFont("Consolas", 14.0, XlColor.FromArgb(0xe3, 0x2c, 0x2e))));
            // Add the rich formatted text to the cell. 
            cell.SetRichText(richText);
        }
    }
}

CellFormattingActions.vb

' Create a new worksheet.
Using sheet As IXlSheet = document.CreateSheet()
    ' Create the first column and set its width.
    Using column As IXlColumn = sheet.CreateColumn()
        column.WidthInPixels = 180
    End Using
    ' Create the first row.
    Using row As IXlRow = sheet.CreateRow()
        ' Create the cell A1.
        Using cell As IXlCell = row.CreateCell()
            ' Create an XlRichTextString instance.
            Dim richText As New XlRichTextString()
            ' Add three text runs to the collection. 
            richText.Runs.Add(New XlRichTextRun("Formatted ", XlFont.CustomFont("Arial", 14.0, XlColor.FromArgb(&H53, &Hbb, &Hf4))))
            richText.Runs.Add(New XlRichTextRun("cell ", XlFont.CustomFont("Century Gothic", 14.0, XlColor.FromArgb(&Hf1, &H77, &H0))))
            richText.Runs.Add(New XlRichTextRun("text", XlFont.CustomFont("Consolas", 14.0, XlColor.FromArgb(&He3, &H2c, &H2e))))
            ' Add the rich formatted text to the cell. 
            cell.SetRichText(richText)
        End Using
    End Using
End Using

Inheritance

Object

XlRichTextRun