Class FigletRenderer

Namespace

SharpConsoleUI.Parsing

Assembly

SharpConsoleUI.dll

Renders text using a FIGlet font into lines of plain characters.

public static class FigletRenderer

Inheritance

object

FigletRenderer

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

Render(string, FigletFont, int)

Renders the given text using the specified FIGlet font. Returns one string per output line.

public static List<string> Render(string text, FigletFont font, int maxWidth = 0)

Parameters

text string

The text to render.

font FigletFont

The FIGlet font to use.

maxWidth int

Maximum output width (0 = unlimited).

Returns

List<string>

A list of output lines.

RenderJustified(string, FigletFont, int, TextJustification)

Renders text with justification applied.

public static List<string> RenderJustified(string text, FigletFont font, int maxWidth, TextJustification justification)

Parameters

text string

The text to render.

font FigletFont

The FIGlet font to use.

maxWidth int

Maximum output width for justification.

justification TextJustification

Text justification.

Returns

List<string>

A list of output lines.

RenderWrapped(string, FigletFont, int, WrapMode)

Renders text with wrapping support. Each wrapped "row" consists of font.Height lines.

public static List<string> RenderWrapped(string text, FigletFont font, int maxWidth, WrapMode wrapMode)

Parameters

text string

The text to render.

font FigletFont

The FIGlet font to use.

maxWidth int

Maximum output width for wrapping.

wrapMode WrapMode

The wrapping mode to apply.

Returns

List<string>

A list of output lines (multiple rows of font.Height lines each).

RenderWrappedJustified(string, FigletFont, int, WrapMode, TextJustification)

Renders text with wrapping and justification applied per row.

public static List<string> RenderWrappedJustified(string text, FigletFont font, int maxWidth, WrapMode wrapMode, TextJustification justification)

Parameters

text string

font FigletFont

maxWidth int

wrapMode WrapMode

justification TextJustification

Returns

List<string>