XlRichTextString.Runs Property

Provides access to the collection of cell text regions, each formatted with its own font.

Namespace: DevExpress.Export.Xl

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

Declaration

C#

public IList<XlRichTextRun> Runs { get; }

VB.NET

Public ReadOnly Property Runs As IList(Of XlRichTextRun)

Property Value

Type	Description
IList<XlRichTextRun>	A collection of XlRichTextRun objects.

Remarks

A worksheet cell may contain a rich formatted text that represents a cell text divided into separate regions (so-called text runs), each of which has its own set of font characteristics. Each run is defined by the XlRichTextRun object and is stored in the collection of runs accessible from the Runs property.

When you create a new XlRichTextString object and set its content using the XlRichTextString.Text property, the Runs collection includes a single run that holds the full cell text formatted with the default font. You can access this run object by its index in the collection and change its font settings using the XlRichTextRun.Font property.

You can also add more runs to the Runs collection to divide the cell text into text regions and specify font properties for each region, as illustrated in the example below.

Note

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

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

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