Embedding Font To Resources

• Download sample project

Introduction

This post discusses how to load and use custom font, embedded in assembly resources.

Solution

We will use PrivateFontCollection as in the previous example private font loading. But we'll need a little bit more action.

Add Font to Resource

First, we add font file into project. Place it in the root folder of the project. Go to property and choose action Embedded Resource for font file.

Load Font from Resource

Next add code to read font from resource.

// specify embedded resource name
string resource = "embedded_font.PAGAP___.TTF";

// receive resource stream
Stream fontStream = Assembly.GetExecutingAssembly().GetManifestResourceStream(resource);

// create an unsafe memory block for the font data
System.IntPtr data = Marshal.AllocCoTaskMem((int)fontStream.Length);

// create a buffer to read in to
byte[] fontdata = new byte[fontStream.Length];

// read the font data from the resource
fontStream.Read(fontdata, 0, (int)fontStream.Length);

// copy the bytes to the unsafe memory block
Marshal.Copy(fontdata, 0, data, (int)fontStream.Length);

// pass the font to the font collection
private_fonts.AddMemoryFont(data, (int)fontStream.Length);

// close the resource stream
fontStream.Close();

// free up the unsafe memory
Marshal.FreeCoTaskMem(data);

After that, we can create font and assign font to label:

label1.Font = new Font(private_fonts.Families[0], 22);

Problems and Workaround

Unfortunately, it will not work instead loaded font from file. The reason is specific to memory loaded fonts, described in remarks to AddMemoryFont method.

To use the memory font, text on a control must be rendered with GDI+. Use the SetCompatibleTextRenderingDefault method, passing true, to set GDI+ rendering on the application, or on individual controls by setting the control's UseCompatibleTextRendering property to true.

You can specify in Program class as follows:

Application.SetCompatibleTextRenderingDefault(true);

But it can affect other controls in the program. As an example, some controls fonts can look ugly. So better specify GDI+ rendering only for chosen controls.

label1.UseCompatibleTextRendering = true;

Result