FigletTextExtensions

Namespace: Hex1b

Assembly: Hex1b.dll

Extension methods for creating and configuring instances using the fluent widget-builder API.

public static class FigletTextExtensions

Inheritance

Object → FigletTextExtensions

Methods

FigletText<TParent>(WidgetContext<TParent>, string)

Creates a with the specified text content.

Parameters:

• context (WidgetContext<<TParent>>): The widget context.
• text (String): The text to render.

Returns: FigletTextWidget

A new using .

public static FigletTextWidget FigletText<TParent>(this WidgetContext<TParent> context, string text) where TParent : Hex1bWidget

Font(FigletTextWidget, FigletFont)

Sets the font used to render the FIGlet text.

Parameters:

• widget (FigletTextWidget): The widget to configure.
• font (FigletFont): The font.

Returns: FigletTextWidget

A new widget instance.

public static FigletTextWidget Font(this FigletTextWidget widget, FigletFont font)

Horizontal(FigletTextWidget, FigletLayoutMode)

Sets the horizontal layout mode.

Parameters:

• widget (FigletTextWidget):
• mode (FigletLayoutMode):

Returns: FigletTextWidget

public static FigletTextWidget Horizontal(this FigletTextWidget widget, FigletLayoutMode mode)

HorizontalOverflow(FigletTextWidget, FigletHorizontalOverflow)

Sets how horizontal overflow is handled.

Parameters:

• widget (FigletTextWidget):
• overflow (FigletHorizontalOverflow):

Returns: FigletTextWidget

public static FigletTextWidget HorizontalOverflow(this FigletTextWidget widget, FigletHorizontalOverflow overflow)

Layout(FigletTextWidget, FigletLayoutMode)

Sets BOTH the horizontal and vertical layout modes to mode. Convenience for the common case where the same mode applies on both axes.

Parameters:

• widget (FigletTextWidget):
• mode (FigletLayoutMode):

Returns: FigletTextWidget

public static FigletTextWidget Layout(this FigletTextWidget widget, FigletLayoutMode mode)

Vertical(FigletTextWidget, FigletLayoutMode)

Sets the vertical layout mode.

Parameters:

• widget (FigletTextWidget):
• mode (FigletLayoutMode):

Returns: FigletTextWidget

public static FigletTextWidget Vertical(this FigletTextWidget widget, FigletLayoutMode mode)

VerticalOverflow(FigletTextWidget, FigletVerticalOverflow)

Sets how vertical overflow is handled.

Parameters:

• widget (FigletTextWidget):
• overflow (FigletVerticalOverflow):

Returns: FigletTextWidget

public static FigletTextWidget VerticalOverflow(this FigletTextWidget widget, FigletVerticalOverflow overflow)

Remarks

These methods follow the noun/verb naming convention used elsewhere in Hex1b (compare TextExtensions.Truncate(), .Wrap(), .Ellipsis()) — there is no With* prefix.

Examples

context.FigletText("Hello, World")
   .Font(FigletFonts.Slant)
   .Layout(FigletLayoutMode.Smushed)
   .HorizontalOverflow(FigletHorizontalOverflow.Wrap);