Skip to content

What ConsoleMonster draws, live and printed once.
- Widgets Every widget at every colour and glyph tier.
- Tables Width negotiation, cards, presenters and totals.
- Live dashboards Recorded runs, replayed frame by frame.
- Live runs Many items in parallel, watch views and Pester runs.
- Interactive Prompts, menus, forms and the grid.
- PowerShell Cmdlets on 5.1 and 7, with their real output.
Install, configure and look things up.
- Docs Install, detection, themes, live sessions, recording.
- Guides Coming from Write-Color, Spectre.Console or Format-Table.
- .NET API Every public type and member.
- Commands Every cmdlet with its parameters.
- Benchmarks Frame cost, update rates and memory.
Current section: .NET API

Class

RunDashboardFluent

ConsoleMonster.Widgets

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

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

Inheritance

object
RunDashboardFluent

Methods

public static RunDashboard WithLog(RunDashboard runDashboard, Action<LogRegion> configure) #

Configures RunDashboard.Log in place: Captured output and completion events. Entries stream to scrollback while its retained history stays bounded.

Parameters

runDashboard ConsoleMonster.Widgets.RunDashboard required: The instance.
configure System.Action<ConsoleMonster.Widgets.LogRegion> required: Configures the value.

Returns

RunDashboard The same instance.

public static RunDashboard WithLogPaused(RunDashboard runDashboard, bool value = true) #

Sets RunDashboard.LogPaused: Whether completion lines are temporarily held.

Parameters

runDashboard ConsoleMonster.Widgets.RunDashboard required: The instance.
value bool = true optional: The value (default true).

Returns

RunDashboard The same instance.

public static RunDashboard WithProblemsOnly(RunDashboard runDashboard, bool value = true) #

Sets RunDashboard.ProblemsOnly: Whether only problems are appended to the log.

Parameters

runDashboard ConsoleMonster.Widgets.RunDashboard required: The instance.
value bool = true optional: The value (default true).

Returns

RunDashboard The same instance.

public static RunDashboard WithShowGroups(RunDashboard runDashboard, bool value = true) #

Sets RunDashboard.ShowGroups: Whether group rows may use spare dashboard space.

Parameters

runDashboard ConsoleMonster.Widgets.RunDashboard required: The instance.
value bool = true optional: The value (default true).

Returns

RunDashboard The same instance.

public static RunDashboard WithShowHelp(RunDashboard runDashboard, bool value = true) #

Sets RunDashboard.ShowHelp: Whether the key help is expanded.

Parameters

runDashboard ConsoleMonster.Widgets.RunDashboard required: The instance.
value bool = true optional: The value (default true).

Returns

RunDashboard The same instance.

public static RunDashboard WithShowKeys(RunDashboard runDashboard, bool value = true) #

Sets RunDashboard.ShowKeys: Whether the key hints are visible.

Parameters

runDashboard ConsoleMonster.Widgets.RunDashboard required: The instance.
value bool = true optional: The value (default true).

Returns

RunDashboard The same instance.

public static RunDashboard WithShowTrend(RunDashboard runDashboard, bool value = true) #

Sets RunDashboard.ShowTrend: The optional throughput trend beside the rate.

Parameters

runDashboard ConsoleMonster.Widgets.RunDashboard required: The instance.
value bool = true optional: The value (default true).

Returns

RunDashboard The same instance.

public static RunDashboard WithTitle(RunDashboard runDashboard, string value) #

Sets RunDashboard.Title: The run name, shown as literal text.

Parameters

runDashboard ConsoleMonster.Widgets.RunDashboard required: The instance.
value string required: The value.

Returns

RunDashboard The same instance.

Inherited Methods