TextPathOptions Class

How a text is placed along a path.

public sealed class TextPathOptions

Remarks

The options are immutable; TextPathOptions.Default starts the text at the start of the path, on its left.

Constructors

NameDescription
TextPathOptions()

TextPathOptions()

public TextPathOptions()

No documentation is available.

Properties

NameDescription
AlignmentGets where the text is placed along the path. TextPathAlignment.Start by default.
BaselineOffsetGets the distance from the path to the baseline of the first line of the text, in pixels: positive to move the text away from the path, on the side it stands on; negative to sink it across the path. 0 by default: the baseline is on the path.
DefaultGets the default options.
OverflowGets what happens to the text beyond the ends of the path. TextPathOverflow.Extend by default.
SideGets the side of the path the text is drawn on. TextPathSide.Left by default.
StartOffsetGets the distance the text is moved along the path from where TextPathOptions.Alignment puts it, in pixels; negative to move it back. 0 by default.

Gets where the text is placed along the path. TextPathAlignment.Start by default.

public TextPathAlignment Alignment { get; init; }

Property value

TextPathAlignment

Exceptions

ArgumentOutOfRangeException
The value is not a member of the enumeration.

BaselineOffset

TextPathOptions.cs

Gets the distance from the path to the baseline of the first line of the text, in pixels: positive to move the text away from the path, on the side it stands on; negative to sink it across the path. 0 by default: the baseline is on the path.

public double BaselineOffset { get; init; }

Property value

double

Exceptions

ArgumentOutOfRangeException
The value is not finite, or its magnitude exceeds 16777216.

Gets the default options.

public static TextPathOptions Default { get; }

Property value

TextPathOptions

Gets what happens to the text beyond the ends of the path. TextPathOverflow.Extend by default.

public TextPathOverflow Overflow { get; init; }

Property value

TextPathOverflow

Exceptions

ArgumentOutOfRangeException
The value is not a member of the enumeration.

Gets the side of the path the text is drawn on. TextPathSide.Left by default.

public TextPathSide Side { get; init; }

Property value

TextPathSide

Exceptions

ArgumentOutOfRangeException
The value is not a member of the enumeration.

Gets the distance the text is moved along the path from where TextPathOptions.Alignment puts it, in pixels; negative to move it back. 0 by default.

public double StartOffset { get; init; }

Property value

double

Exceptions

ArgumentOutOfRangeException
The value is not finite, or its magnitude exceeds 16777216.