API Reference
OfficeTextShapingRequest
Describes a Unicode text run and font passed to a shared shaping provider.
Inheritance
- Object
- OfficeTextShapingRequest
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Accepted by parameters
Constructors
public OfficeTextShapingRequest(String text, String fontName, Byte[] fontData, Boolean isOpenTypeCff, Int32 unitsPerEm, OfficeTextDirection direction = Auto, String language = null) #Creates an immutable text-shaping request.
Parameters
- text System.String
- Original UTF-16 text to shape.
- fontName System.String
- Display or resource name of the selected font.
- fontData System.Byte[]
- Complete font-program snapshot.
- isOpenTypeCff System.Boolean
- True for OpenType/CFF outlines; false for TrueType outlines.
- unitsPerEm System.Int32
- Font design units per em.
- direction OfficeIMO.Drawing.OfficeTextDirection = Auto
- Resolved base direction for the run.
- language System.String = null
- Optional BCP 47 language hint.
public OfficeTextShapingRequest(String text, String fontName, Byte[] fontData, Boolean isOpenTypeCff, Int32 unitsPerEm, OfficeTextDirection direction, String language, OfficeTextFeatureSettings featureSettings) #Creates an immutable text-shaping request with explicit OpenType feature values.
Parameters
- text System.String
- fontName System.String
- fontData System.Byte[]
- isOpenTypeCff System.Boolean
- unitsPerEm System.Int32
- direction OfficeIMO.Drawing.OfficeTextDirection
- language System.String
- featureSettings OfficeIMO.Drawing.OfficeTextFeatureSettings
public OfficeTextShapingRequest(String text, String fontName, Byte[] fontData, Boolean isOpenTypeCff, Int32 unitsPerEm, OfficeTextDirection direction, String language, CancellationToken cancellationToken) #Creates an immutable text-shaping request with cooperative cancellation.
Parameters
- text System.String
- fontName System.String
- fontData System.Byte[]
- isOpenTypeCff System.Boolean
- unitsPerEm System.Int32
- direction OfficeIMO.Drawing.OfficeTextDirection
- language System.String
- cancellationToken System.Threading.CancellationToken
public OfficeTextShapingRequest(String text, String fontName, Byte[] fontData, Boolean isOpenTypeCff, Int32 unitsPerEm, OfficeTextDirection direction, String language, CancellationToken cancellationToken, Nullable<Int32> fontCollectionIndex) #Creates an immutable text-shaping request for a selected face in a font collection.
Parameters
- text System.String
- fontName System.String
- fontData System.Byte[]
- isOpenTypeCff System.Boolean
- unitsPerEm System.Int32
- direction OfficeIMO.Drawing.OfficeTextDirection
- language System.String
- cancellationToken System.Threading.CancellationToken
- fontCollectionIndex System.Nullable{System.Int32}
public OfficeTextShapingRequest(String text, String fontName, Byte[] fontData, Boolean isOpenTypeCff, Int32 unitsPerEm, OfficeTextDirection direction, String language, CancellationToken cancellationToken, Nullable<Int32> fontCollectionIndex, IReadOnlyDictionary<String, Single> variationCoordinates) #Creates an immutable text-shaping request for a selected variable-font instance.
Parameters
- text System.String
- fontName System.String
- fontData System.Byte[]
- isOpenTypeCff System.Boolean
- unitsPerEm System.Int32
- direction OfficeIMO.Drawing.OfficeTextDirection
- language System.String
- cancellationToken System.Threading.CancellationToken
- fontCollectionIndex System.Nullable{System.Int32}
- variationCoordinates System.Collections.Generic.IReadOnlyDictionary{System.String,System.Single}
public OfficeTextShapingRequest(String text, String fontName, Byte[] fontData, Boolean isOpenTypeCff, Int32 unitsPerEm, OfficeTextDirection direction, String language, CancellationToken cancellationToken, Nullable<Int32> fontCollectionIndex, IReadOnlyDictionary<String, Single> variationCoordinates, OfficeTextFeatureSettings featureSettings) #Creates an immutable text-shaping request for a selected variable-font instance with explicit OpenType feature values.
Parameters
- text System.String
- fontName System.String
- fontData System.Byte[]
- isOpenTypeCff System.Boolean
- unitsPerEm System.Int32
- direction OfficeIMO.Drawing.OfficeTextDirection
- language System.String
- cancellationToken System.Threading.CancellationToken
- fontCollectionIndex System.Nullable{System.Int32}
- variationCoordinates System.Collections.Generic.IReadOnlyDictionary{System.String,System.Single}
- featureSettings OfficeIMO.Drawing.OfficeTextFeatureSettings
Inherited Methods
public override Boolean Equals(Object obj) #BooleanParameters
- obj Object
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 Boolean IsOpenTypeCff { get; } #True for OpenType/CFF outlines; false for TrueType outlines.
public Int32 UnitsPerEm { get; } #Font design units per em used by glyph advances and offsets.
public Nullable<Int32> FontCollectionIndex { get; } #Selected zero-based face when 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, Single> VariationCoordinates { get; } #Clamped design-space values for the selected variable-font instance.
public OfficeTextFeatureSettings FeatureSettings { get; } #Explicit OpenType feature values for this run.