Skip to content
ConsoleMonster

API Reference

Class

FooterBarFluent

Namespace ConsoleMonster.Widgets
Assembly ConsoleMonster
Modifiers static
Attributes
GeneratedCode("ConsoleMonster.Generators", "1.0.0")

The fluent methods of FooterBar, generated from its public properties: With... sets a property and Add... adds to a collection, both returning the same instance.

Inheritance

  • Object
  • FooterBarFluent

Methods

public static FooterBar AddHint(FooterBar footerBar, KeyHint item) #
Returns: FooterBar

Adds an item to FooterBar.Hints: The hints, in order.

Parameters

footerBar ConsoleMonster.Widgets.FooterBar requiredposition: 0
The instance.
item ConsoleMonster.Widgets.KeyHint requiredposition: 1
The item.

Returns

The same instance.

AddHints 2 overloads
public static FooterBar AddHints(FooterBar footerBar, params KeyHint[] items) #
Returns: FooterBar

Adds items to FooterBar.Hints: The hints, in order.

Parameters

footerBar ConsoleMonster.Widgets.FooterBar requiredposition: 0
The instance.
items ConsoleMonster.Widgets.KeyHint[] requiredposition: 1
The items, in order.

Returns

The same instance.

public static FooterBar AddHints(FooterBar footerBar, IEnumerable<KeyHint> items) #
Returns: FooterBar

Adds items to FooterBar.Hints: The hints, in order.

Parameters

footerBar ConsoleMonster.Widgets.FooterBar requiredposition: 0
The instance.
items System.Collections.Generic.IEnumerable<ConsoleMonster.Widgets.KeyHint> requiredposition: 1
The items, in order.

Returns

The same instance.

public static FooterBar WithIndent(FooterBar footerBar, Int32 value) #
Returns: FooterBar

Sets FooterBar.Indent: The first column (default 1).

Parameters

footerBar ConsoleMonster.Widgets.FooterBar requiredposition: 0
The instance.
value System.Int32 requiredposition: 1
The value.

Returns

The same instance.

public static FooterBar WithKeepLast(FooterBar footerBar, Boolean value = true) #
Returns: FooterBar

Sets FooterBar.KeepLast: Keeps the last hint (the key map) when others have to be dropped.

Parameters

footerBar ConsoleMonster.Widgets.FooterBar requiredposition: 0
The instance.
value System.Boolean = true optionalposition: 1
The value (default true).

Returns

The same instance.

public static FooterBar WithMessage(FooterBar footerBar, StyledLine? value) #
Returns: FooterBar

Sets FooterBar.Message: A line shown instead of the hints (a toast), or null.

Parameters

footerBar ConsoleMonster.Widgets.FooterBar requiredposition: 0
The instance.
value ConsoleMonster.Text.StyledLine? requiredposition: 1
The value.

Returns

The same instance.

public static FooterBar WithRight(FooterBar footerBar, StyledLine? value) #
Returns: FooterBar

Sets FooterBar.Right: Text on the right, or null.

Parameters

footerBar ConsoleMonster.Widgets.FooterBar requiredposition: 0
The instance.
value ConsoleMonster.Text.StyledLine? requiredposition: 1
The value.

Returns

The same instance.