Table of Contents

Class GlyphRun

Namespace
DocWright.Core.Rendering
Assembly
DocWright.Core.dll

A positioned run of text glyphs on a single baseline.

public sealed class GlyphRun : ILayoutPrimitive
Inheritance
GlyphRun
Implements
Inherited Members

Constructors

GlyphRun(string, string, Twips, ColorRgb, Twips, Twips, IReadOnlyList<GlyphClusterAdvance>, UnderlineStyle, ColorRgb, bool, bool, bool, bool, bool, bool)

Initializes a glyph run.

GlyphRun(string, string, Twips, ColorRgb, Twips, Twips, IReadOnlyList<GlyphClusterAdvance>, UnderlineStyle, ColorRgb, bool, bool, bool, bool, bool, bool, IReadOnlyList<GlyphClusterMap>?)

Initializes a glyph run with optional shaped cluster-map metadata.

GlyphRun(string, string, Twips, ColorRgb, Twips, Twips, IReadOnlyList<GlyphClusterAdvance>, UnderlineStyle, ColorRgb, bool, bool, bool, bool, bool, bool, IReadOnlyList<GlyphClusterMap>?, GlyphOrientation)

Initializes a glyph run with optional shaped cluster-map metadata and a quarter-turn orientation.

GlyphRun(string, string, Twips, ColorRgb, Twips, Twips, IReadOnlyList<GlyphClusterAdvance>, UnderlineStyle, ColorRgb, bool, bool, bool, bool, bool, bool, IReadOnlyList<GlyphClusterMap>?, GlyphOrientation, GlyphRunSource)

Initializes a glyph run with optional shaped cluster-map metadata, a quarter-turn orientation and the document text it was laid out from.

Properties

BaselineX

Gets the baseline X position in twips.

BaselineY

Gets the baseline Y position in twips.

Bold

Gets whether the run is bold.

ClusterAdvances

Gets the per-cluster advances.

ClusterMap

Gets optional logical-to-shaped cluster mappings.

Color

Gets the run color.

DoubleStrike

Gets double-strike decoration.

FontFamily

Gets the font family.

FontSize

Gets the font size in twips.

Italic

Gets whether the run is italic.

Orientation

Gets the quarter turn applied to the run's baseline. Upright for ordinary horizontal text, which is every run a document produced before rotated text existed and the default of every constructor that does not name it.

Source

Gets the document text the run was laid out from, or None. Layout fills it only when asked to (LayoutEngine.EmitSourceReferences); every constructor that does not name it gives None. Renderers ignore it.

Strike

Gets single-strike decoration.

SyntheticBold

Gets whether synthetic bold simulation is required.

SyntheticItalic

Gets whether synthetic italic simulation is required.

Text

Gets the run text.

Underline

Gets the underline style.

UnderlineColor

Gets the underline color.