Class RichTextOptions

Provides configuration options for rendering and shaping of rich text.

Inheritance

object

TextOptions

RichTextOptions

Inherited Members

TextOptions.Font

TextOptions.FallbackFontFamilies

TextOptions.Dpi

TextOptions.TabWidth

TextOptions.HintingMode

TextOptions.LineSpacing

TextOptions.Origin

TextOptions.WrappingLength

TextOptions.WordBreaking

TextOptions.TextDirection

TextOptions.TextAlignment

TextOptions.TextJustification

TextOptions.HorizontalAlignment

TextOptions.VerticalAlignment

TextOptions.LayoutMode

TextOptions.KerningMode

TextOptions.ColorFontSupport

TextOptions.FeatureTags

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: SixLabors.ImageSharp.Drawing.Processing

Assembly: SixLabors.ImageSharp.Drawing.dll

Syntax

public class RichTextOptions : TextOptions

Constructors

RichTextOptions(Font)

Initializes a new instance of the RichTextOptions class.

Declaration

public RichTextOptions(Font font)

Parameters

Type	Name	Description
Font	font	The font.

RichTextOptions(RichTextOptions)

Initializes a new instance of the RichTextOptions class from properties copied from the given instance.

Declaration

public RichTextOptions(RichTextOptions options)

Parameters

Type	Name	Description
RichTextOptions	options	The options whose properties are copied into this instance.

Properties

Path

Gets or sets an optional path to draw the text along.

Declaration

public IPath? Path { get; set; }

Property Value

Type	Description
IPath

Remarks

When this property is not null the Origin property is automatically applied as a translation to a copy of the path for processing.

TextRuns

Gets or sets an optional collection of text runs to apply to the body of text.

Declaration

public IReadOnlyList<RichTextRun> TextRuns { get; set; }

Property Value

Type	Description
IReadOnlyList<RichTextRun>