Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

OfficeFontFaceCollection

OfficeIMO.Drawing

Namespace
OfficeIMO.Drawing
Assembly
OfficeIMO.Core
Source revision
ba882f6b0d07 with working tree changes
Modifiers
sealed

Scoped caller-supplied font faces used by drawing measurement, rasterization, and SVG export. Direct TrueType/OpenType, WOFF 1, WOFF 2, CFF/CFF2, and variable-font containers are handled by the first-party engine. An optional provider can override program loading for specialized engines.

Inheritance

  • object
  • OfficeFontFaceCollection

Usage

Explore 18 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Accepted by parameters 5

Constructors

public OfficeFontFaceCollection() #

Creates an empty scoped font collection.

Methods

Add 4 overloads
public OfficeFontFaceCollection Add(string familyName, byte[] data, OfficeFontStyle style = Regular) #

Adds or replaces one family/style face. Invalid or unsupported font bytes throw.

Parameters

familyName string required
data byte[] required
style OfficeIMO.Drawing.OfficeFontStyle = Regular optional
public OfficeFontFaceCollection Add(string familyName, byte[] data, OfficeFontFaceDescriptor descriptor) #

Adds or replaces one numerically described family face. Invalid or unsupported font bytes throw.

Parameters

familyName string required
data byte[] required
descriptor OfficeIMO.Drawing.OfficeFontFaceDescriptor required
public OfficeFontFaceCollection Add(string familyName, byte[] data, OfficeFontStyle style, OfficeFontUnicodeRangeSet unicodeRanges) #

Adds or replaces one unicode-range-constrained family/style face. A deterministic internal resource family is assigned when the range does not cover all Unicode scalars.

Parameters

familyName string required
data byte[] required
style OfficeIMO.Drawing.OfficeFontStyle required
unicodeRanges OfficeIMO.Drawing.OfficeFontUnicodeRangeSet required
public OfficeFontFaceCollection Add(string familyName, byte[] data, OfficeFontFaceDescriptor descriptor, OfficeFontUnicodeRangeSet unicodeRanges) #

Adds or replaces one unicode-range-constrained, numerically described family face.

Parameters

familyName string required
data byte[] required
descriptor OfficeIMO.Drawing.OfficeFontFaceDescriptor required
unicodeRanges OfficeIMO.Drawing.OfficeFontUnicodeRangeSet required
public OfficeFontFaceCollection AddAlias(string aliasFamilyName, string sourceFamilyName) #

Adds another family name for all faces already registered under an existing family. The alias reuses the immutable decoded font programs without decoding or copying them again.

Parameters

aliasFamilyName string required
Additional family name accepted by measurement and export.
sourceFamilyName string required
Existing family whose faces and unicode ranges are reused.

Returns

OfficeFontFaceCollection This collection for fluent configuration.
public OfficeFontFaceCollection AddFallbackFamily(string familyName) #

Appends one registered family to the fallback chain used when requested faces do not cover a text element.

Parameters

familyName string required
Registered family or resource family name to append.

Returns

OfficeFontFaceCollection This collection for fluent configuration.
public OfficeFontFaceCollection AddRange(OfficeFontFaceCollection? fonts) #

Adds independent copies of all faces from another collection.

Parameters

fonts OfficeIMO.Drawing.OfficeFontFaceCollection? required
public OfficeFontFaceCollection AddRangePreservingExisting(OfficeFontFaceCollection? fonts) #

Adds independent copies of faces from another collection without replacing faces already registered under the same family, resource family, and style. Added faces are considered before existing fallback families, while existing document-scoped faces retain precedence.

Parameters

fonts OfficeIMO.Drawing.OfficeFontFaceCollection? required
public OfficeFontFaceCollection Clone() #

Creates an independent collection snapshot.

PlanFallbackRuns 2 overloads
public IReadOnlyList<OfficeFontFallbackRun> PlanFallbackRuns(string? text, string? familyNames, OfficeFontStyle style = Regular) #

Splits text into grapheme-safe runs using the first scoped family whose selected face covers each text element. Unresolved elements retain the original family list for platform or adapter fallback.

Parameters

text string? required
familyNames string? required
style OfficeIMO.Drawing.OfficeFontStyle = Regular optional

Returns

IReadOnlyList<OfficeFontFallbackRun>
public IReadOnlyList<OfficeFontFallbackRun> PlanFallbackRuns(string? text, string? familyNames, OfficeFontFaceDescriptor descriptor) #

Splits text into grapheme-safe runs after matching numeric weight, stretch, and slant for each family.

Parameters

text string? required
familyNames string? required
descriptor OfficeIMO.Drawing.OfficeFontFaceDescriptor required

Returns

IReadOnlyList<OfficeFontFallbackRun>
TryAdd 4 overloads
public bool TryAdd(string? familyName, byte[]? data, OfficeFontStyle style = Regular) #

Attempts to add or replace one family/style face without throwing for unsupported font data.

Parameters

familyName string? required
data byte[]? required
style OfficeIMO.Drawing.OfficeFontStyle = Regular optional

Returns

bool
public bool TryAdd(string? familyName, byte[]? data, OfficeFontFaceDescriptor descriptor) #

Attempts to add or replace one numerically described family face.

Parameters

familyName string? required
data byte[]? required
descriptor OfficeIMO.Drawing.OfficeFontFaceDescriptor required

Returns

bool
public bool TryAdd(string? familyName, byte[]? data, OfficeFontStyle style, OfficeFontUnicodeRangeSet? unicodeRanges) #

Attempts to add or replace one unicode-range-constrained family/style face. A deterministic internal resource family is assigned when the range does not cover all Unicode scalars.

Parameters

familyName string? required
data byte[]? required
style OfficeIMO.Drawing.OfficeFontStyle required
unicodeRanges OfficeIMO.Drawing.OfficeFontUnicodeRangeSet? required

Returns

bool
public bool TryAdd(string? familyName, byte[]? data, OfficeFontFaceDescriptor descriptor, OfficeFontUnicodeRangeSet? unicodeRanges) #

Attempts to add or replace one unicode-range-constrained, numerically described family face.

Parameters

familyName string? required
data byte[]? required
descriptor OfficeIMO.Drawing.OfficeFontFaceDescriptor required
unicodeRanges OfficeIMO.Drawing.OfficeFontUnicodeRangeSet? required

Returns

bool
public bool TryMeasureText(string? text, double fontSize, string? familyNames, OfficeFontStyle style, out double width) #

Attempts to measure text with a matching scoped face.

Parameters

text string? required
fontSize double required
familyNames string? required
style OfficeIMO.Drawing.OfficeFontStyle required
width double required

Returns

bool
TryResolveFaceForText 4 overloads
public bool TryResolveFaceForText(string? text, string? familyNames, OfficeFontStyle style, out OfficeFontFace? face) #

Resolves the scoped face that covers the supplied text for the requested CSS/Office family list and style. This uses the same unicode-range and fallback rules as measurement and rendering, requesting weight 400 for regular text or 700 for bold text with the corresponding upright or italic slant.

Parameters

text string? required
familyNames string? required
style OfficeIMO.Drawing.OfficeFontStyle required
face OfficeIMO.Drawing.OfficeFontFace? required

Returns

bool
public bool TryResolveFaceForText(string? text, string? familyNames, OfficeFontStyle style, double fontSize, out OfficeFontFace? face) #

Resolves a face at the authored text size, selecting a built-in TrueType optical axis automatically unless the variation resolver explicitly supplied opsz. Provider-owned programs retain their provider-selected axes.

Parameters

text string? required
familyNames string? required
style OfficeIMO.Drawing.OfficeFontStyle required
fontSize double required
face OfficeIMO.Drawing.OfficeFontFace? required

Returns

bool
public bool TryResolveFaceForText(string? text, string? familyNames, OfficeFontFaceDescriptor descriptor, double fontSize, out OfficeFontFace? face) #

Resolves numeric weight, stretch, and slant with automatic built-in TrueType optical sizing.

Parameters

text string? required
familyNames string? required
descriptor OfficeIMO.Drawing.OfficeFontFaceDescriptor required
fontSize double required
face OfficeIMO.Drawing.OfficeFontFace? required

Returns

bool
public bool TryResolveFaceForText(string? text, string? familyNames, OfficeFontFaceDescriptor descriptor, out OfficeFontFace? face) #

Resolves a scoped face using numeric weight, stretch, and slant matching.

Parameters

text string? required
familyNames string? required
descriptor OfficeIMO.Drawing.OfficeFontFaceDescriptor required
face OfficeIMO.Drawing.OfficeFontFace? required

Returns

bool

Properties

public IOfficeFontProgramProvider? FontProgramProvider { get; set; } #

Optional decoder and outline engine for formats outside the dependency-free core. The provider reference is retained by collection clones; decoded face programs are immutable.

public Func<OfficeFontProgramLoadRequest, IReadOnlyDictionary<string, float>?>? FontVariationResolver { get; set; } #

Optional variable-font axis resolver invoked for each accepted face. Values are clamped to the font-defined axis range; unknown axes and non-finite values fail closed.

public IReadOnlyList<OfficeFontFace> Faces { get; } #

Registered faces in registration order.

public IReadOnlyList<string> FallbackFamilies { get; } #

Registered fallback families considered after the families requested by a text run.