Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

OfficeTextShapingRequest

OfficeIMO.Drawing

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

Describes a Unicode text run and font passed to a shared shaping provider.

Inheritance

  • object
  • OfficeTextShapingRequest

Usage

Explore 2 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 2

Constructors

OfficeTextShapingRequest 6 overloads
public OfficeTextShapingRequest(string text, string fontName, byte[] fontData, bool isOpenTypeCff, int unitsPerEm, OfficeTextDirection direction = Auto, string? language = null) #

Creates an immutable text-shaping request.

Parameters

text string required
Original UTF-16 text to shape.
fontName string required
Display or resource name of the selected font.
fontData byte[] required
Complete font-program snapshot.
isOpenTypeCff bool required
True for OpenType/CFF outlines; false for TrueType outlines.
unitsPerEm int required
Font design units per em.
direction OfficeIMO.Drawing.OfficeTextDirection = Auto optional
Resolved base direction for the run.
language string? = null optional
Optional BCP 47 language hint.
public OfficeTextShapingRequest(string text, string fontName, byte[] fontData, bool isOpenTypeCff, int unitsPerEm, OfficeTextDirection direction, string? language, OfficeTextFeatureSettings featureSettings) #

Creates an immutable text-shaping request with explicit OpenType feature values.

Parameters

text string required
fontName string required
fontData byte[] required
isOpenTypeCff bool required
unitsPerEm int required
direction OfficeIMO.Drawing.OfficeTextDirection required
language string? required
featureSettings OfficeIMO.Drawing.OfficeTextFeatureSettings required
public OfficeTextShapingRequest(string text, string fontName, byte[] fontData, bool isOpenTypeCff, int unitsPerEm, OfficeTextDirection direction, string? language, CancellationToken cancellationToken) #

Creates an immutable text-shaping request with cooperative cancellation.

Parameters

text string required
fontName string required
fontData byte[] required
isOpenTypeCff bool required
unitsPerEm int required
direction OfficeIMO.Drawing.OfficeTextDirection required
language string? required
cancellationToken System.Threading.CancellationToken required
public OfficeTextShapingRequest(string text, string fontName, byte[] fontData, bool isOpenTypeCff, int unitsPerEm, OfficeTextDirection direction, string? language, CancellationToken cancellationToken, int? fontCollectionIndex) #

Creates an immutable text-shaping request for a selected face in a font collection.

Parameters

text string required
fontName string required
fontData byte[] required
isOpenTypeCff bool required
unitsPerEm int required
direction OfficeIMO.Drawing.OfficeTextDirection required
language string? required
cancellationToken System.Threading.CancellationToken required
fontCollectionIndex int? required
public OfficeTextShapingRequest(string text, string fontName, byte[] fontData, bool isOpenTypeCff, int unitsPerEm, OfficeTextDirection direction, string? language, CancellationToken cancellationToken, int? fontCollectionIndex, IReadOnlyDictionary<string, float>? variationCoordinates) #

Creates an immutable text-shaping request for a selected variable-font instance.

Parameters

text string required
fontName string required
fontData byte[] required
isOpenTypeCff bool required
unitsPerEm int required
direction OfficeIMO.Drawing.OfficeTextDirection required
language string? required
cancellationToken System.Threading.CancellationToken required
fontCollectionIndex int? required
variationCoordinates System.Collections.Generic.IReadOnlyDictionary<string, float>? required
public OfficeTextShapingRequest(string text, string fontName, byte[] fontData, bool isOpenTypeCff, int unitsPerEm, OfficeTextDirection direction, string? language, CancellationToken cancellationToken, int? fontCollectionIndex, IReadOnlyDictionary<string, float>? variationCoordinates, OfficeTextFeatureSettings featureSettings) #

Creates an immutable text-shaping request for a selected variable-font instance with explicit OpenType feature values.

Parameters

text string required
fontName string required
fontData byte[] required
isOpenTypeCff bool required
unitsPerEm int required
direction OfficeIMO.Drawing.OfficeTextDirection required
language string? required
cancellationToken System.Threading.CancellationToken required
fontCollectionIndex int? required
variationCoordinates System.Collections.Generic.IReadOnlyDictionary<string, float>? required
featureSettings OfficeIMO.Drawing.OfficeTextFeatureSettings required

Properties

public string Text { get; } #

Original UTF-16 text to shape.

public string FontName { get; } #

Display or resource name of the selected font.

public byte[] FontData { get; } #

Defensive snapshot of the complete font program.

public bool IsOpenTypeCff { get; } #

True for OpenType/CFF outlines; false for TrueType outlines.

public int UnitsPerEm { get; } #

Font design units per em used by glyph advances and offsets.

public int? FontCollectionIndex { get; } #

Selected zero-based face when OfficeTextShapingRequest.FontData contains a TrueType collection.

public OfficeTextDirection Direction { get; } #

Resolved base direction of the run.

public string? Language { get; } #

Optional BCP 47 language hint.

public CancellationToken CancellationToken { get; } #

Cancellation observed by cooperative host shapers.

public IReadOnlyDictionary<string, float> VariationCoordinates { get; } #

Clamped design-space values for the selected variable-font instance.

public OfficeTextFeatureSettings FeatureSettings { get; } #

Explicit OpenType feature values for this run.