How to: Load and Use Custom Fonts in the Rich Text Editor

• Oct 27, 2021
• 3 minutes to read

The WinForms Rich Text Editor ships with the FontRepository class that allows you to use fonts that are not installed on the current operating system. When you load a document that uses such fonts, the Rich Text Editor substitutes missing fonts with the fonts available on the current machine. The FontRepository class allows you to load and use custom fonts in your application to prevent font substitution when documents are displayed, printed, or exported to PDF.

Use the FontRepository.Instance static property to access a FontRepository instance.

Add Fonts to the Font Repository

Use the FontRepository.AddFont method overloads to add fonts to the font repository. You can load a font from a file, stream, or byte array. Loaded fonts are available to all RichEditControl instances within your project.

Supported font formats include:

• TrueType fonts (.TTF)

• OpenType fonts that use CFF (Compact Font Format) glyph outlines (.OTF)

• OpenType Font Collections (.TTC, .OTC) that contain multiple fonts in a single file

To avoid excessive document layout recalculations, add the required fonts to FontRepository before you load a document that uses these fonts.

The code sample below adds the following Google fonts fonts to FontRepository and uses these fonts to format document paragraphs:

• Emilys Candy
• Fredericka the Great

C#

using DevExpress.Office;
using DevExpress.XtraRichEdit;
using DevExpress.XtraRichEdit.API.Native;
using System.Drawing;

namespace WinFormsRichTextEditor
{
    public partial class Form1 : DevExpress.XtraBars.Ribbon.RibbonForm
    {
        public Form1()
        {
            InitializeComponent();

            FontRepository.Instance.AddFont(@"Fonts\EmilysCandy-Regular.ttf");
            FontRepository.Instance.AddFont(@"Fonts\FrederickatheGreat-Regular.ttf");

            Document document = richEditControl1.Document;
            // Load a document.
            document.LoadDocument(@"Documents\AliceInWonderland.docx");

            // Format the first paragraph, which contains the book title. 
            var titleFormatting =
              document.BeginUpdateCharacters(document.Paragraphs[0].Range);
            FormatCharacters(titleFormatting, 20,
              "Fredericka the Great", Color.FromArgb(0x2E, 0x74, 0xB5));
            document.EndUpdateCharacters(titleFormatting);

            // Format the second paragraph, which contains the author's name. 
            var subtitleFormatting =
              document.BeginUpdateCharacters(document.Paragraphs[1].Range);
            FormatCharacters(subtitleFormatting, 14,
              "Emilys Candy", Color.FromArgb(0x3B, 0x38, 0x38));
            document.EndUpdateCharacters(subtitleFormatting);
        }

        private static void FormatCharacters(CharacterProperties formatting, 
            float size, string fontName, Color color)
        {
            formatting.FontSize = size;
            formatting.FontName = fontName;
            formatting.ForeColor = color;
        }
    }
}

VB.NET

Imports DevExpress.Office
Imports DevExpress.XtraRichEdit
Imports DevExpress.XtraRichEdit.API.Native
Imports System.Drawing

Namespace WinFormsRichTextEditor
    Public Class Form1
        Inherits DevExpress.XtraBars.Ribbon.RibbonForm

        Public Sub New()
            InitializeComponent()

            FontRepository.Instance.AddFont("Fonts\EmilysCandy-Regular.ttf")
            FontRepository.Instance.AddFont("Fonts\FrederickatheGreat-Regular.ttf")

            Dim document As Document = richEditControl1.Document
            ' Load a document.
            document.LoadDocument("Documents\AliceInWonderland.docx")

            ' Format the first paragraph, which contains the book title. 
            Dim titleFormatting As CharacterProperties = 
              document.BeginUpdateCharacters(document.Paragraphs(0).Range)
            FormatCharacters(titleFormatting, 20, "Fredericka the Great", 
                            Color.FromArgb(&H2E, &H74, &HB5))
            document.EndUpdateCharacters(titleFormatting)

            ' Format the second paragraph, which contains the author's name. 
            Dim subtitleFormatting As CharacterProperties = 
              document.BeginUpdateCharacters(document.Paragraphs(1).Range)
            FormatCharacters(subtitleFormatting, 14, "Emilys Candy", 
                            Color.FromArgb(&H3B, &H38, &H38))
            document.EndUpdateCharacters(subtitleFormatting)
        End Sub

        Private Shared Sub FormatCharacters(ByVal formatting As CharacterProperties, ByVal size As Single, 
                                            ByVal fontName As String, ByVal color As Color)
            formatting.FontSize = size
            formatting.FontName = fontName
            formatting.ForeColor = color
        End Sub
    End Class
End Namespace

The following image demonstrates the result:

Obtain Information About Fonts in the Repository

Use the FontRepository.GetFonts method to return a list of all fonts in the font repository. Each item in this list is a FontData object that contains font information.

Clear the Font Repository

Call the FontRepository.Clear method to remove all fonts from the font repository. Use the FontRepository.IsEmpty property to check whether the repository contains fonts.

C#

using DevExpress.Office;
// ...

// Check whether the font repository is empty.
if (!FontRepository.Instance.IsEmpty)
    // If false, clear the font repository.
    FontRepository.Instance.Clear();

VB.NET

Imports DevExpress.Office
' ...

' Check whether the font repository is empty.
If Not FontRepository.Instance.IsEmpty Then
    ' If false, clear the font repository.
    FontRepository.Instance.Clear()
End If

Limitations

1. Loaded fonts are not saved to a document. These fonts are used to display the document in the control’s UI, print the document, or export the document to PDF.

2. Loaded fonts are not displayed in the drop-down list of the Rich Text Editor’s font editor.