Class TextInstructionStyle

Namespace

EncDotNet.S100.Portrayals.Application

Assembly

EncDotNet.S100.Portrayals.dll

How an InstructionBuilder draws text: font, colour tokens, halo, alignment and offset. The defaults match a TextInstruction's.

public sealed record TextInstructionStyle : IEquatable<TextInstructionStyle>

Inheritance

object

TextInstructionStyle

Implements

IEquatable<TextInstructionStyle>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

FontColor

The text's colour token. Defaults to CHBLK.

public string FontColor { get; init; }

Property Value

string

FontProportion

The font proportion.

public TextFontProportion FontProportion { get; init; }

Property Value

TextFontProportion

FontSize

The font size, which the mariner's text scale multiplies. Defaults to 10.

public double FontSize { get; init; }

Property Value

double

FontWeight

The font weight.

public TextFontWeight FontWeight { get; init; }

Property Value

TextFontWeight

HaloColor

The halo's colour token, or null (the default) for no halo.

public string? HaloColor { get; init; }

Property Value

string

HaloWidth

The halo's width in millimetres.

public double HaloWidth { get; init; }

Property Value

double

HorizontalAlignment

Horizontal alignment relative to the anchor.

public TextHorizontalAlignment HorizontalAlignment { get; init; }

Property Value

TextHorizontalAlignment

OffsetX

Horizontal offset from the anchor in millimetres, or null for none.

public double? OffsetX { get; init; }

Property Value

double?

OffsetY

Vertical offset from the anchor in millimetres, or null for none.

public double? OffsetY { get; init; }

Property Value

double?

VerticalAlignment

Vertical alignment relative to the anchor.

public TextVerticalAlignment VerticalAlignment { get; init; }

Property Value

TextVerticalAlignment