PdfFont Class


PdfFont Class

Represents a font in a pdf document. Five ways to create one:

CreateStandardFont(PdfStandardFont, Single) — one of the 14 built-in PDF fonts (Helvetica, Times, Courier, Symbol, ZapfDingbats). Fastest, smallest output, but not embedded — rejected by PDF/A.
CreateCJKFont(PdfStandardCJKFont, Single) — one of the 7 standard CJK fonts. Also not embedded; shipped with PDF/A-compliant readers.
CreateFromFile(String, Single) / CreateFromStream(Stream, Single) / CreateFromBytes(Byte, Single) — loads a TrueType (.ttf) or OpenType (.otf) font from the filesystem or memory. The font is subset-embedded into the output PDF, which is required for PDF/A output from scratch.
CreateFromSystemFont(String, Single) — resolves a font installed on the host system by family name. The font is subset-embedded, just like the file / stream / bytes overloads.

Inheritance Hierarchy

SystemObject
SelectPdf.UniversalPdfFont

Namespace: SelectPdf.Universal
Assembly: SelectPdf.Universal (in SelectPdf.Universal.dll) Version: 26.4

Syntax

Copy

public class PdfFont

Public Class PdfFont

The PdfFont type exposes the following members.

Properties

	Name	Description
	FontBaseFamily	Gets the predefined font family (one of the 14 standard PDF fonts) used when this font was created via CreateStandardFont(PdfStandardFont, Single). Returns Helvetica as a default if the font was not created from a standard family.
	FontFamily	Gets the name of the font family.
	Height	Gets the font height.
	IsStrikeout	A flag to indicate if the font is strikeout.
	IsUnderline	A flag to indicate if the font is underline.
	Size	Gets or sets the font size in points.

Top

Methods

	Name	Description
	Clone	Creates a clone of this font, associated with the specified pdf document.
	CreateCJKFont	Creates a PdfFont from a standard Korean / Japanese / Chinese (CJK) font family. Like CreateStandardFont(PdfStandardFont, Single), these fonts are referenced by name (not embedded) — they ship with PDF/A-compliant readers, so the output is expected to render on any conforming viewer.
	CreateFromBytes	Loads a TrueType / OpenType font from an in-memory byte array and creates a PdfFont. Convenience wrapper around CreateFromStream(Stream, Single); the font is subset-embedded into the output.
	CreateFromFile	Loads a TrueType (.ttf) or OpenType (.otf) font from a file path and creates a PdfFont. The font is subset-embedded into the output document — the subset only contains glyphs that are actually used, keeping file size small. This is the path to use for PDF/A and PDF/X output from scratch.
	CreateFromStream	Loads a TrueType / OpenType font from a Stream and creates a PdfFont. The stream must be positioned at the start of the font data and is read synchronously in full. The font is subset-embedded into the output.
	CreateFromSystemFont(PdfSystemFont)	Resolves the system font described by systemFont and creates a PdfFont. Equivalent to CreateFromSystemFont(String, Single, PdfFontStyle) with the descriptor's family / size / style.
	CreateFromSystemFont(String, Single)	Resolves a font installed on the host system by family name and creates a PdfFont. Loads the actual TrueType / OpenType file via PdfSystemFonts and subset-embeds it into the output document.
	CreateFromSystemFont(String, Single, PdfFontStyle)	Resolves a system font by family name + style and creates a PdfFont. The font is subset-embedded into the output document.
	CreateStandardFont	Creates a PdfFont from a standard PDF font family and size.
	GetCharWidth	Gets the width of the specified character in points.
	GetSystemFont	Gets the system font this font was created from, or null when it did not come from one.
	GetTextSize	Gets the size (width and height) in points of the specified string when rendered with this font.
	GetTextWidth	Gets the width in points of the specified string.

Top

Remarks

Fonts created via CreateStandardFont(PdfStandardFont, Single) can have Size / IsUnderline / IsStrikeout mutated after construction. TrueType, CJK, and externally-wrapped fonts are immutable — the setters throw on anything other than a standard font.

Example

Copy

// A built-in font (fast, not embedded)
PdfFont font = PdfFont.CreateStandardFont(PdfStandardFont.Helvetica, 12f);
PdfDocument document = new PdfDocument();
document.Fonts.Add(font);

// An embedded TrueType font (required for PDF/A output)
PdfFont title = PdfFont.CreateFromFile(@"C:\Windows\Fonts\arial.ttf", 22f);
float width = title.GetTextWidth("Hello world");

' A built-in font (fast, not embedded)
Dim font As PdfFont = PdfFont.CreateStandardFont(PdfStandardFont.Helvetica, 12.0F)
Dim document As New PdfDocument()
document.Fonts.Add(font)

' An embedded TrueType font (required for PDF/A output)
Dim title As PdfFont = PdfFont.CreateFromFile("C:\Windows\Fonts\arial.ttf", 22.0F)
Dim width As Single = title.GetTextWidth("Hello world")

Reference

SelectPdf.Universal Namespace