Skip to content
ConsoleMonster

API Reference

Class

SummaryBarFluent

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

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

Inheritance

  • Object
  • SummaryBarFluent

Methods

public static SummaryBar WithBarWidth(SummaryBar summaryBar, Int32 value) #
Returns: SummaryBar

Sets SummaryBar.BarWidth: The bar width in cells (default 20; narrow regions shrink it).

Parameters

summaryBar ConsoleMonster.Widgets.SummaryBar requiredposition: 0
The instance.
value System.Int32 requiredposition: 1
The value.

Returns

The same instance.

public static SummaryBar WithDoneLabel(SummaryBar summaryBar, String? value) #
Returns: SummaryBar

Sets SummaryBar.DoneLabel: The label for the count done while the total is unknown, with {0} for the count, or null (default) for "{0} done".

Parameters

summaryBar ConsoleMonster.Widgets.SummaryBar requiredposition: 0
The instance.
value System.String? requiredposition: 1
The value.

Returns

The same instance.

public static SummaryBar WithElapsed(SummaryBar summaryBar, TimeSpan? value) #
Returns: SummaryBar

Sets SummaryBar.Elapsed: The elapsed time to estimate from, or null (default) for the time since the first progress.

Parameters

summaryBar ConsoleMonster.Widgets.SummaryBar requiredposition: 0
The instance.
value System.TimeSpan? requiredposition: 1
The value.

Returns

The same instance.

public static SummaryBar WithShowDuration(SummaryBar summaryBar, Boolean value = true) #
Returns: SummaryBar

Sets SummaryBar.ShowDuration: Whether a finished run shows how long it took ("in 12s") after the counters (default true; needs SummaryBar.Elapsed).

Parameters

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

Returns

The same instance.