# OfficeTextShapingRequest

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

Class 

`OfficeIMO.Drawing`

**Namespace**

`OfficeIMO.Drawing`

**Assembly**

`OfficeIMO.Core`

**Source revision**

`ba882f6b0d07` with working tree changes

**Source**

[OfficeTextShaping.cs:63](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/OfficeTextShaping.cs#L63)

**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

- Method [IOfficeTextShapingProvider.ShapeText](/api/core/officeimo-drawing-iofficetextshapingprovider/#method-shapetext-officeimo-drawing-officetextshapingrequest) parameter `request`
- Method [OfficeManagedTextShapingProvider.ShapeText](/api/core/officeimo-drawing-officemanagedtextshapingprovider/#method-shapetext-officeimo-drawing-officetextshapingrequest) parameter `request`

Filter members 

Show inherited

## Constructors

OfficeTextShapingRequest 6 overloads

`public OfficeTextShapingRequest(string text, string fontName, byte[] fontData, bool isOpenTypeCff, int unitsPerEm, OfficeTextDirection direction = Auto, string? language = null)` [#](#constructor-ctor-string-string-byte-boolean-int32-officeimo-drawing-officetextdirection-string)

[OfficeTextShaping.cs:63](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/OfficeTextShaping.cs#L63)

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)` [#](#constructor-ctor-string-string-byte-boolean-int32-officeimo-drawing-officetextdirection-string-officeimo-drawing-officetextfeaturesettings)

[OfficeTextShaping.cs:88](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/OfficeTextShaping.cs#L88)

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)` [#](#constructor-ctor-string-string-byte-boolean-int32-officeimo-drawing-officetextdirection-string-threading-cancellationtoken)

[OfficeTextShaping.cs:113](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/OfficeTextShaping.cs#L113)

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)` [#](#constructor-ctor-string-string-byte-boolean-int32-officeimo-drawing-officetextdirection-string-threading-cancellationtoken-nullable-system-int32)

[OfficeTextShaping.cs:139](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/OfficeTextShaping.cs#L139)

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)` [#](#member-35fc644a65acb71901ff6a3b)

[OfficeTextShaping.cs:166](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/OfficeTextShaping.cs#L166)

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)` [#](#member-f1d6d4481c210018aff9d8cb)

[OfficeTextShaping.cs:194](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/OfficeTextShaping.cs#L194)

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**

## Inherited Methods

`public virtual bool Equals(object? obj)` [#](#method-equals-object)

Inherited from object

Parameters

**obj object? required**

Returns

`bool`

`public virtual int GetHashCode()` [#](#method-gethashcode)

Inherited from object

Returns

`int`

`public Type GetType()` [#](#method-gettype)

Inherited from object

Returns

`Type`

`public virtual string? ToString()` [#](#method-tostring)

Inherited from object

Returns

`string?`

## Properties

`public string Text { get; }` [#](#property-text)

[OfficeTextShaping.cs:258](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/OfficeTextShaping.cs#L258)

Original UTF-16 text to shape.

`public string FontName { get; }` [#](#property-fontname)

[OfficeTextShaping.cs:261](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/OfficeTextShaping.cs#L261)

Display or resource name of the selected font.

`public byte[] FontData { get; }` [#](#property-fontdata)

[OfficeTextShaping.cs:264](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/OfficeTextShaping.cs#L264)

Defensive snapshot of the complete font program.

`public bool IsOpenTypeCff { get; }` [#](#property-isopentypecff)

[OfficeTextShaping.cs:275](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/OfficeTextShaping.cs#L275)

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

`public int UnitsPerEm { get; }` [#](#property-unitsperem)

[OfficeTextShaping.cs:278](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/OfficeTextShaping.cs#L278)

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

`public int? FontCollectionIndex { get; }` [#](#property-fontcollectionindex)

[OfficeTextShaping.cs:281](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/OfficeTextShaping.cs#L281)

Selected zero-based face when [OfficeTextShapingRequest.FontData](/api/core/officeimo-drawing-officetextshapingrequest/) contains a TrueType collection.

`public OfficeTextDirection Direction { get; }` [#](#property-direction)

[OfficeTextShaping.cs:284](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/OfficeTextShaping.cs#L284)

Resolved base direction of the run.

`public string? Language { get; }` [#](#property-language)

[OfficeTextShaping.cs:287](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/OfficeTextShaping.cs#L287)

Optional BCP 47 language hint.

`public CancellationToken CancellationToken { get; }` [#](#property-cancellationtoken)

[OfficeTextShaping.cs:290](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/OfficeTextShaping.cs#L290)

Cancellation observed by cooperative host shapers.

`public IReadOnlyDictionary<string, float> VariationCoordinates { get; }` [#](#property-variationcoordinates)

[OfficeTextShaping.cs:293](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/OfficeTextShaping.cs#L293)

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

`public OfficeTextFeatureSettings FeatureSettings { get; }` [#](#property-featuresettings)

[OfficeTextShaping.cs:298](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/OfficeTextShaping.cs#L298)

Explicit OpenType feature values for this run.

<!-- PowerForge markdown artifact sha256:DB8F66A8614882F183634DD85546584C7135BB01A7F37D89E61E572D4EFE4DC9 -->
