Class FigletText

Renders text in a DarkEffekt.Terminal.FigletFont as rows of characters. Lines stack at the font’s full height.

Assembly: DarkEffekt.Terminal.Core

Declaration

public sealed class FigletText

Properties

Font

The font the text is drawn in.

Declaration

public FigletFont Font { get; }

Mode

How glyphs are set side by side.

Declaration

public FigletMode Mode { get; set; }

Rules

The horizontal smushing rules to use when smushing. Null takes the font’s. DarkEffekt.Terminal.FigletLayout.FullWidth (no rules) gives universal smushing.

Declaration

public FigletLayout? Rules { get; set; }

Direction

The direction glyphs are laid out in. Null takes the font’s.

Declaration

public FigletDirection? Direction { get; set; }

MaxWidth

The widest a row may get, in columns. Longer lines break at spaces, and a word wider than this breaks between glyphs. Zero or less turns wrapping off.

Declaration

public int MaxWidth { get; set; }

Methods

Render(string)

The rows of the rendered text, top to bottom, with hardblanks turned to spaces. Each line of the text gives the font’s height in rows, all of one length; a line feed starts a new line. Empty text gives no rows.

Declaration

public string[] Render(string text)

Returns

System.String[]

Parameters

Type	Name
System.String	text