Class TextOnPathOptions

Options controlling text placement along a baseline path for DrawStringOnPath(string, Font, Brush, GraphicsPath, StringFormat?, TextOnPathOptions?) and AddStringOnPath(string, FontFamily, int, float, GraphicsPath, StringFormat?, TextOnPathOptions?).

Inheritance

object

TextOnPathOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: DRIT.Drawing.Text

Assembly: DRIT.Drawing.dll

Syntax

public sealed class TextOnPathOptions

Constructors

TextOnPathOptions()

Initializes a empty TextOnPathOptions instance.

Declaration

public TextOnPathOptions()

Properties

Alignment

Controls alignment of the text block along the path, overriding Alignment. When non-null, the text is aligned within the usable path length (total length minus StartOffset). Default null (use StringFormat.Alignment).

Declaration

public StringAlignment? Alignment { get; set; }

Property Value

Type	Description
StringAlignment?

Overflow

Behavior when the text is longer than the available path length. Default Stop (place glyphs until the path ends, then stop).

Declaration

public TextOnPathOverflow Overflow { get; set; }

Property Value

Type	Description
TextOnPathOverflow

PerpendicularOffset

Perpendicular offset of each glyph's baseline from the path. Positive values place glyphs "above" the path (toward smaller Y for a rightward-traveling path). In page units for DrawStringOnPath, pixels for AddStringOnPath. Default 0 (glyphs sit on the path).

Declaration

public float PerpendicularOffset { get; set; }

Property Value

Type	Description
float

StartOffset

Distance along the path (in page units for DrawStringOnPath, pixels for AddStringOnPath) at which to start placing the first glyph's pen position. Default 0.

Declaration

public float StartOffset { get; set; }

Property Value

Type	Description
float