Class FontEngineOptions

Namespace: DocWright.Fonts

Assembly: DocWright.Fonts.dll

Configuration for building one immutable FontEngine instance.

public sealed class FontEngineOptions

Inheritance: object

FontEngineOptions

Inherited Members: object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

FontEngineOptions(): Initializes options with the default metric-compatible substitution map.

Properties

EmbeddedFonts: Gets embedded fonts (for example from DOCX) that are indexed together with file-system fonts.

FallbackFamilies: Gets the ordered fallback family chain used when no exact or substitution match is found.

FontDirectories: Gets additional font directories scanned before platform directories.

IncludeBundledMetricFonts: Gets or sets a value indicating whether the metric-compatible substitute fonts bundled inside DocWright.Fonts (Carlito, Caladea, Liberation Serif/Sans/Mono) are indexed as a last-priority origin. These make the MetricCompatibleMap targets resolve even on a machine with none of them installed. Default: true.

IncludeSystemFontDirectories: Gets or sets a value indicating whether platform system font directories are scanned. Default: true.

MetricCompatibleMap: Gets the metric-compatible substitution map, tried before PANOSE distance (source family → replacement family). Keys are matched case-insensitively.

ScriptFallbackFonts: Gets or sets the per-script glyph-level fallback chains. When a resolved font is available but lacks a glyph for a specific codepoint, the shaper resolves that cluster against the chain keyed by the codepoint's UnicodeScript — distinct from family-level substitution, which handles a missing font. Empty by default.