Class

LiveFluent

ConsoleMonster.Live

Namespace: ConsoleMonster.Live
Assembly: ConsoleMonster
Modifiers: static

The fluent methods of WidgetUpdate, generated from its public properties: A property-named method sets a property and Add... adds to a collection, both returning the same instance.

Inheritance

object
LiveFluent

Methods

Append 2 overloads

public static WidgetUpdate Append(WidgetUpdate widgetUpdate, bool value) #

Sets WidgetUpdate.Append: Whether Value is a new numeric sample.

Parameters

widgetUpdate ConsoleMonster.Live.WidgetUpdate required: The instance.
value bool required: The value.

Returns

WidgetUpdate The same instance.

Examples

// C# initializer or property                                       // C# fluent
new global::ConsoleMonster.Live.WidgetUpdate { Append = value };    widgetUpdate.Append(value);

public static WidgetUpdate Append(WidgetUpdate widgetUpdate) #

Sets WidgetUpdate.Append to true.

Parameters

widgetUpdate ConsoleMonster.Live.WidgetUpdate required: The instance to configure.

Returns

WidgetUpdate The same instance.

AppendCells 2 overloads

public static WidgetUpdate AppendCells(WidgetUpdate widgetUpdate, bool value) #

Sets WidgetUpdate.AppendCells: Whether to append cells.

Parameters

widgetUpdate ConsoleMonster.Live.WidgetUpdate required: The instance.
value bool required: The value.

Returns

WidgetUpdate The same instance.

Examples

// C# initializer or property                                            // C# fluent
new global::ConsoleMonster.Live.WidgetUpdate { AppendCells = value };    widgetUpdate.AppendCells(value);

public static WidgetUpdate AppendCells(WidgetUpdate widgetUpdate) #

Sets WidgetUpdate.AppendCells to true.

Parameters

widgetUpdate ConsoleMonster.Live.WidgetUpdate required: The instance to configure.

Returns

WidgetUpdate The same instance.

public static LiveSessionOptions AutoRecord(LiveSessionOptions liveSessionOptions, int value) #

Sets LiveSessionOptions.AutoRecord: Opt-in automatic recording: when above zero and neither LiveSessionOptions.RecordPath nor LiveSessionOptions.RecordWriter is set, the session records itself to LiveSessionOptions.AutoRecordFolder and keeps only this many recordings with its LiveSessionOptions.RecordingName (the newest ones; other files are never removed), so the last runs can be rewound with Show-ConsoleReplay. Default 0 (off).

Parameters

liveSessionOptions ConsoleMonster.Live.LiveSessionOptions required: The instance.
value int required: The value.

Returns

LiveSessionOptions The same instance.

Examples

// C# initializer or property                                                 // C# fluent
new global::ConsoleMonster.Live.LiveSessionOptions { AutoRecord = value };    liveSessionOptions.AutoRecord(value);

public static LiveSessionOptions AutoRecordFolder(LiveSessionOptions liveSessionOptions, string? value) #

Sets LiveSessionOptions.AutoRecordFolder: Where automatic recordings go, or null for %LOCALAPPDATA%\ConsoleMonster\Recordings (on Linux and macOS the local application data folder, usually ~/.local/share).

Parameters

liveSessionOptions ConsoleMonster.Live.LiveSessionOptions required: The instance.
value string? required: The value.

Returns

LiveSessionOptions The same instance.

Examples

// C# initializer or property                                                       // C# fluent
new global::ConsoleMonster.Live.LiveSessionOptions { AutoRecordFolder = value };    liveSessionOptions.AutoRecordFolder(value);

public static LiveSessionOptions AutoRecordMaxBytes(LiveSessionOptions liveSessionOptions, long value) #

Sets LiveSessionOptions.AutoRecordMaxBytes: The most bytes the automatic recordings with one LiveSessionOptions.RecordingName may take together (default 50 MB): older recordings are removed first, and a single recording stops growing at this size.

Parameters

liveSessionOptions ConsoleMonster.Live.LiveSessionOptions required: The instance.
value long required: The value.

Returns

LiveSessionOptions The same instance.

Examples

// C# initializer or property                                                         // C# fluent
new global::ConsoleMonster.Live.LiveSessionOptions { AutoRecordMaxBytes = value };    liveSessionOptions.AutoRecordMaxBytes(value);

CaptureConsole 2 overloads

public static LiveSessionOptions CaptureConsole(LiveSessionOptions liveSessionOptions, bool value) #

Sets LiveSessionOptions.CaptureConsole: Captures standard output and error while running; defaults to true.

Parameters

liveSessionOptions ConsoleMonster.Live.LiveSessionOptions required: The instance.
value bool required: The value.

Returns

LiveSessionOptions The same instance.

Examples

// C# initializer or property                                                     // C# fluent
new global::ConsoleMonster.Live.LiveSessionOptions { CaptureConsole = value };    liveSessionOptions.CaptureConsole(value);

public static LiveSessionOptions CaptureConsole(LiveSessionOptions liveSessionOptions) #

Sets LiveSessionOptions.CaptureConsole to true.

Parameters

liveSessionOptions ConsoleMonster.Live.LiveSessionOptions required: The instance to configure.

Returns

LiveSessionOptions The same instance.

public static WidgetUpdate CellCount(WidgetUpdate widgetUpdate, int value) #

Sets WidgetUpdate.CellCount: The new number of cells.

Parameters

widgetUpdate ConsoleMonster.Live.WidgetUpdate required: The instance.
value int required: The value.

Returns

WidgetUpdate The same instance.

Examples

// C# initializer or property                                          // C# fluent
new global::ConsoleMonster.Live.WidgetUpdate { CellCount = value };    widgetUpdate.CellCount(value);

ClearRows 2 overloads

public static WidgetUpdate ClearRows(WidgetUpdate widgetUpdate, bool value) #

Sets WidgetUpdate.ClearRows: Whether to clear all table rows.

Parameters

widgetUpdate ConsoleMonster.Live.WidgetUpdate required: The instance.
value bool required: The value.

Returns

WidgetUpdate The same instance.

Examples

// C# initializer or property                                          // C# fluent
new global::ConsoleMonster.Live.WidgetUpdate { ClearRows = value };    widgetUpdate.ClearRows(value);

public static WidgetUpdate ClearRows(WidgetUpdate widgetUpdate) #

Sets WidgetUpdate.ClearRows to true.

Parameters

widgetUpdate ConsoleMonster.Live.WidgetUpdate required: The instance to configure.

Returns

WidgetUpdate The same instance.

Complete 2 overloads

public static WidgetUpdate Complete(WidgetUpdate widgetUpdate, bool value) #

Sets WidgetUpdate.Complete: Whether to complete an activity or lane.

Parameters

widgetUpdate ConsoleMonster.Live.WidgetUpdate required: The instance.
value bool required: The value.

Returns

WidgetUpdate The same instance.

Examples

// C# initializer or property                                         // C# fluent
new global::ConsoleMonster.Live.WidgetUpdate { Complete = value };    widgetUpdate.Complete(value);

public static WidgetUpdate Complete(WidgetUpdate widgetUpdate) #

Sets WidgetUpdate.Complete to true.

Parameters

widgetUpdate ConsoleMonster.Live.WidgetUpdate required: The instance to configure.

Returns

WidgetUpdate The same instance.

Configure 4 overloads

public static LiveRunOptions Configure(LiveRunOptions liveRunOptions, Action<LiveRunOptions> configure) #

Assigns callbacks and related configuration without invoking delegate-valued properties.

Parameters

liveRunOptions ConsoleMonster.Live.LiveRunOptions required: The instance.
configure System.Action<ConsoleMonster.Live.LiveRunOptions> required: Assignments applied in order.

Returns

LiveRunOptions The same instance.

Examples

// C# initializer or property                                        // C# fluent
new global::ConsoleMonster.Live.LiveRunOptions { Clock = value };    liveRunOptions.Configure(configured => configured.Clock = value);

public static LiveSessionOptions Configure(LiveSessionOptions liveSessionOptions, Action<LiveSessionOptions> configure) #

Assigns callbacks and related configuration without invoking delegate-valued properties.

Parameters

liveSessionOptions ConsoleMonster.Live.LiveSessionOptions required: The instance.
configure System.Action<ConsoleMonster.Live.LiveSessionOptions> required: Assignments applied in order.

Returns

LiveSessionOptions The same instance.

Examples

// C# initializer or property                                            // C# fluent
new global::ConsoleMonster.Live.LiveSessionOptions { Clock = value };    liveSessionOptions.Configure(configured => configured.Clock = value);

// C# initializer or property                                                  // C# fluent
new global::ConsoleMonster.Live.LiveSessionOptions { ReplayDelay = value };    liveSessionOptions.Configure(configured => configured.ReplayDelay = value);

public static RunOptions Configure(RunOptions runOptions, Action<RunOptions> configure) #

Assigns callbacks and related configuration without invoking delegate-valued properties.

Parameters

runOptions ConsoleMonster.Live.RunOptions required: The instance.
configure System.Action<ConsoleMonster.Live.RunOptions> required: Assignments applied in order.

Returns

RunOptions The same instance.

Examples

// C# initializer or property                                    // C# fluent
new global::ConsoleMonster.Live.RunOptions { Label = value };    runOptions.Configure(configured => configured.Label = value);

// C# initializer or property                                    // C# fluent
new global::ConsoleMonster.Live.RunOptions { Print = value };    runOptions.Configure(configured => configured.Print = value);

public static WatchOptions Configure(WatchOptions watchOptions, Action<WatchOptions> configure) #

Assigns callbacks and related configuration without invoking delegate-valued properties.

Parameters

watchOptions ConsoleMonster.Live.WatchOptions required: The instance.
configure System.Action<ConsoleMonster.Live.WatchOptions> required: Assignments applied in order.

Returns

WatchOptions The same instance.

Examples

// C# initializer or property                                      // C# fluent
new global::ConsoleMonster.Live.WatchOptions { Print = value };    watchOptions.Configure(configured => configured.Print = value);

// C# initializer or property                                      // C# fluent
new global::ConsoleMonster.Live.WatchOptions { Delay = value };    watchOptions.Configure(configured => configured.Delay = value);

public static WidgetUpdate Content(WidgetUpdate widgetUpdate, IWidget? value) #

Sets WidgetUpdate.Content: The replacement region content; null empties it.

Parameters

widgetUpdate ConsoleMonster.Live.WidgetUpdate required: The instance.
value ConsoleMonster.Layout.IWidget? required: The value.

Returns

WidgetUpdate The same instance.

Examples

// C# initializer or property                                        // C# fluent
new global::ConsoleMonster.Live.WidgetUpdate { Content = value };    widgetUpdate.Content(value);

Count 2 overloads

public static WidgetUpdate Count(WidgetUpdate widgetUpdate, int value) #

Sets WidgetUpdate.Count: The number of appended cells; the default is one.

Parameters

widgetUpdate ConsoleMonster.Live.WidgetUpdate required: The instance.
value int required: The value.

Returns

WidgetUpdate The same instance.

Examples

// C# initializer or property                                      // C# fluent
new global::ConsoleMonster.Live.WidgetUpdate { Count = value };    widgetUpdate.Count(value);

public static WatchOptions Count(WatchOptions watchOptions, int value) #

Sets WatchOptions.Count: How many runs, or 0 (default) until cancelled.

Parameters

watchOptions ConsoleMonster.Live.WatchOptions required: The instance.
value int required: The value.

Returns

WatchOptions The same instance.

Examples

// C# initializer or property                                      // C# fluent
new global::ConsoleMonster.Live.WatchOptions { Count = value };    watchOptions.Count(value);

public static WidgetUpdate Counter(WidgetUpdate widgetUpdate, IDictionary<string, int>? value) #

Sets WidgetUpdate.Counter: The summary counters, in enumeration order.

Parameters

widgetUpdate ConsoleMonster.Live.WidgetUpdate required: The instance.
value System.Collections.Generic.IDictionary<string, int>? required: The value.

Returns

WidgetUpdate The same instance.

Examples

// C# initializer or property                                        // C# fluent
new global::ConsoleMonster.Live.WidgetUpdate { Counter = value };    widgetUpdate.Counter(value);

public static LiveSessionOptions Culture(LiveSessionOptions liveSessionOptions, CultureInfo? value) #

Sets LiveSessionOptions.Culture: The culture for numbers and dates in the session's widgets, overriding the profile's (and CONSOLEMONSTER_CULTURE); null keeps the profile culture, which defaults to the current culture.

Parameters

liveSessionOptions ConsoleMonster.Live.LiveSessionOptions required: The instance.
value System.Globalization.CultureInfo? required: The value.

Returns

LiveSessionOptions The same instance.

Examples

// C# initializer or property                                              // C# fluent
new global::ConsoleMonster.Live.LiveSessionOptions { Culture = value };    liveSessionOptions.Culture(value);

Cut 2 overloads

public static WidgetUpdate Cut(WidgetUpdate widgetUpdate, bool value) #

Sets WidgetUpdate.Cut: Whether to sever the selected edge; omission preserves its connection state.

Parameters

widgetUpdate ConsoleMonster.Live.WidgetUpdate required: The instance.
value bool required: The value.

Returns

WidgetUpdate The same instance.

Examples

// C# initializer or property                                    // C# fluent
new global::ConsoleMonster.Live.WidgetUpdate { Cut = value };    widgetUpdate.Cut(value);

public static WidgetUpdate Cut(WidgetUpdate widgetUpdate) #

Sets WidgetUpdate.Cut to true.

Parameters

widgetUpdate ConsoleMonster.Live.WidgetUpdate required: The instance to configure.

Returns

WidgetUpdate The same instance.

Detail 2 overloads

public static WidgetUpdate Detail(WidgetUpdate widgetUpdate, string? value) #

Sets WidgetUpdate.Detail: The replacement detail; null explicitly clears it.

Parameters

widgetUpdate ConsoleMonster.Live.WidgetUpdate required: The instance.
value string? required: The value.

Returns

WidgetUpdate The same instance.

Examples

// C# initializer or property                                       // C# fluent
new global::ConsoleMonster.Live.WidgetUpdate { Detail = value };    widgetUpdate.Detail(value);

public static RunUpdate Detail(RunUpdate runUpdate, string? value) #

Sets RunUpdate.Detail: The completion detail.

Parameters

runUpdate ConsoleMonster.Live.RunUpdate required: The instance.
value string? required: The value.

Returns

RunUpdate The same instance.

Examples

// C# initializer or property                                    // C# fluent
new global::ConsoleMonster.Live.RunUpdate { Detail = value };    runUpdate.Detail(value);

Differences 2 overloads

public static WatchOptions Differences(WatchOptions watchOptions, bool value) #

Sets WatchOptions.Differences: Whether cells that changed since the previous run are highlighted.

Parameters

watchOptions ConsoleMonster.Live.WatchOptions required: The instance.
value bool required: The value.

Returns

WatchOptions The same instance.

Examples

// C# initializer or property                                            // C# fluent
new global::ConsoleMonster.Live.WatchOptions { Differences = value };    watchOptions.Differences(value);

public static WatchOptions Differences(WatchOptions watchOptions) #

Sets WatchOptions.Differences to true.

Parameters

watchOptions ConsoleMonster.Live.WatchOptions required: The instance to configure.

Returns

WatchOptions The same instance.

Discoverable 2 overloads

public static LiveSessionOptions Discoverable(LiveSessionOptions liveSessionOptions, bool value) #

Sets LiveSessionOptions.Discoverable: Whether the session can be found through LiveSession.Current (default true), so update cmdlets and prompts started elsewhere reach it. A session that runs other code, such as a test run, turns it off: that code's own updates and prompts then behave as if no dashboard were running.

Parameters

liveSessionOptions ConsoleMonster.Live.LiveSessionOptions required: The instance.
value bool required: The value.

Returns

LiveSessionOptions The same instance.

Examples

// C# initializer or property                                                   // C# fluent
new global::ConsoleMonster.Live.LiveSessionOptions { Discoverable = value };    liveSessionOptions.Discoverable(value);

public static LiveSessionOptions Discoverable(LiveSessionOptions liveSessionOptions) #

Sets LiveSessionOptions.Discoverable to true.

Parameters

liveSessionOptions ConsoleMonster.Live.LiveSessionOptions required: The instance to configure.

Returns

LiveSessionOptions The same instance.

public static RunUpdate Duration(RunUpdate runUpdate, TimeSpan? value) #

Sets RunUpdate.Duration: An optional measured duration.

Parameters

runUpdate ConsoleMonster.Live.RunUpdate required: The instance.
value System.TimeSpan? required: The value.

Returns

RunUpdate The same instance.

Examples

// C# initializer or property                                      // C# fluent
new global::ConsoleMonster.Live.RunUpdate { Duration = value };    runUpdate.Duration(value);

public static WidgetUpdate EdgeKey(WidgetUpdate widgetUpdate, string? value) #

Sets WidgetUpdate.EdgeKey: The flow edge to update; exclusive with NodeKey.

Parameters

widgetUpdate ConsoleMonster.Live.WidgetUpdate required: The instance.
value string? required: The value.

Returns

WidgetUpdate The same instance.

Examples

// C# initializer or property                                        // C# fluent
new global::ConsoleMonster.Live.WidgetUpdate { EdgeKey = value };    widgetUpdate.EdgeKey(value);

public static LiveSessionOptions FramesPerSecond(LiveSessionOptions liveSessionOptions, double value) #

Sets LiveSessionOptions.FramesPerSecond: Maximum frame frequency, clamped to 1–60; defaults to 15.

Parameters

liveSessionOptions ConsoleMonster.Live.LiveSessionOptions required: The instance.
value double required: The value.

Returns

LiveSessionOptions The same instance.

Examples

// C# initializer or property                                                      // C# fluent
new global::ConsoleMonster.Live.LiveSessionOptions { FramesPerSecond = value };    liveSessionOptions.FramesPerSecond(value);

HandleCancelKey 2 overloads

public static LiveSessionOptions HandleCancelKey(LiveSessionOptions liveSessionOptions, bool value) #

Sets LiveSessionOptions.HandleCancelKey: Intercepts the first Ctrl+C for cooperative cancellation; defaults to true.

Parameters

liveSessionOptions ConsoleMonster.Live.LiveSessionOptions required: The instance.
value bool required: The value.

Returns

LiveSessionOptions The same instance.

Examples

// C# initializer or property                                                      // C# fluent
new global::ConsoleMonster.Live.LiveSessionOptions { HandleCancelKey = value };    liveSessionOptions.HandleCancelKey(value);

public static LiveSessionOptions HandleCancelKey(LiveSessionOptions liveSessionOptions) #

Sets LiveSessionOptions.HandleCancelKey to true.

Parameters

liveSessionOptions ConsoleMonster.Live.LiveSessionOptions required: The instance to configure.

Returns

LiveSessionOptions The same instance.

public static LiveRunOptions HeightPercent(LiveRunOptions liveRunOptions, double value) #

Sets LiveRunOptions.HeightPercent: Maximum percentage of terminal height used by the dashboard, default 40. Header and problems share the available rows on very short terminals.

Parameters

liveRunOptions ConsoleMonster.Live.LiveRunOptions required: The instance.
value double required: The value.

Returns

LiveRunOptions The same instance.

Examples

// C# initializer or property                                                // C# fluent
new global::ConsoleMonster.Live.LiveRunOptions { HeightPercent = value };    liveRunOptions.HeightPercent(value);

public static WidgetUpdate Increment(WidgetUpdate widgetUpdate, double value) #

Sets WidgetUpdate.Increment: The additive change, including zero.

Parameters

widgetUpdate ConsoleMonster.Live.WidgetUpdate required: The instance.
value double required: The value.

Returns

WidgetUpdate The same instance.

Examples

// C# initializer or property                                          // C# fluent
new global::ConsoleMonster.Live.WidgetUpdate { Increment = value };    widgetUpdate.Increment(value);

Index 2 overloads

public static WidgetUpdate Index(WidgetUpdate widgetUpdate, int[]? value) #

Sets WidgetUpdate.Index: The zero-based cell positions.

Parameters

widgetUpdate ConsoleMonster.Live.WidgetUpdate required: The instance.
value int[]? required: The value.

Returns

WidgetUpdate The same instance.

Examples

// C# initializer or property                                      // C# fluent
new global::ConsoleMonster.Live.WidgetUpdate { Index = value };    widgetUpdate.Index(value);

public static RunUpdate Index(RunUpdate runUpdate, int value) #

Sets RunUpdate.Index: The zero-based item position.

Parameters

runUpdate ConsoleMonster.Live.RunUpdate required: The instance.
value int required: The value.

Returns

RunUpdate The same instance.

Examples

// C# initializer or property                                   // C# fluent
new global::ConsoleMonster.Live.RunUpdate { Index = value };    runUpdate.Index(value);

public static LiveSessionOptions InlineHeightFraction(LiveSessionOptions liveSessionOptions, double value) #

Sets LiveSessionOptions.InlineHeightFraction: Maximum fraction of the current terminal height occupied by inline output, between zero (exclusive) and one. Default one.

Parameters

liveSessionOptions ConsoleMonster.Live.LiveSessionOptions required: The instance.
value double required: The value.

Returns

LiveSessionOptions The same instance.

Examples

// C# initializer or property                                                           // C# fluent
new global::ConsoleMonster.Live.LiveSessionOptions { InlineHeightFraction = value };    liveSessionOptions.InlineHeightFraction(value);

InteractiveKeys 2 overloads

public static LiveRunOptions InteractiveKeys(LiveRunOptions liveRunOptions, bool value) #

Sets LiveRunOptions.InteractiveKeys: Enable p/f/g/? keyboard controls when input is available. Default false.

Parameters

liveRunOptions ConsoleMonster.Live.LiveRunOptions required: The instance.
value bool required: The value.

Returns

LiveRunOptions The same instance.

Examples

// C# initializer or property                                                  // C# fluent
new global::ConsoleMonster.Live.LiveRunOptions { InteractiveKeys = value };    liveRunOptions.InteractiveKeys(value);

public static LiveRunOptions InteractiveKeys(LiveRunOptions liveRunOptions) #

Sets LiveRunOptions.InteractiveKeys to true.

Parameters

liveRunOptions ConsoleMonster.Live.LiveRunOptions required: The instance to configure.

Returns

LiveRunOptions The same instance.

Key 2 overloads

public static WidgetUpdate Key(WidgetUpdate widgetUpdate, string? value) #

Sets WidgetUpdate.Key: The item key within the addressed widget.

Parameters

widgetUpdate ConsoleMonster.Live.WidgetUpdate required: The instance.
value string? required: The value.

Returns

WidgetUpdate The same instance.

Examples

// C# initializer or property                                    // C# fluent
new global::ConsoleMonster.Live.WidgetUpdate { Key = value };    widgetUpdate.Key(value);

public static ConsoleTableRow Key(ConsoleTableRow consoleTableRow, string value) #

Sets ConsoleTableRow.Key: The stable row key.

Parameters

consoleTableRow ConsoleMonster.Live.ConsoleTableRow required: The instance.
value string required: The value.

Returns

ConsoleTableRow The same instance.

Examples

// C# initializer or property                                       // C# fluent
new global::ConsoleMonster.Live.ConsoleTableRow { Key = value };    consoleTableRow.Key(value);

Label 2 overloads

public static WidgetUpdate Label(WidgetUpdate widgetUpdate, string? value) #

Sets WidgetUpdate.Label: The replacement label; null explicitly clears it.

Parameters

widgetUpdate ConsoleMonster.Live.WidgetUpdate required: The instance.
value string? required: The value.

Returns

WidgetUpdate The same instance.

Examples

// C# initializer or property                                      // C# fluent
new global::ConsoleMonster.Live.WidgetUpdate { Label = value };    widgetUpdate.Label(value);

public static RunUpdate Label(RunUpdate runUpdate, string? value) #

Sets RunUpdate.Label: The current phase label.

Parameters

runUpdate ConsoleMonster.Live.RunUpdate required: The instance.
value string? required: The value.

Returns

RunUpdate The same instance.

Examples

// C# initializer or property                                   // C# fluent
new global::ConsoleMonster.Live.RunUpdate { Label = value };    runUpdate.Label(value);

Live 6 overloads

public static LiveRunOptions Live(LiveRunOptions liveRunOptions, bool value) #

Sets LiveRunOptions.Live: Allow live rendering when supported by the terminal; false selects append-only output.

Parameters

liveRunOptions ConsoleMonster.Live.LiveRunOptions required: The instance.
value bool required: The value.

Returns

LiveRunOptions The same instance.

Examples

// C# initializer or property                                       // C# fluent
new global::ConsoleMonster.Live.LiveRunOptions { Live = value };    liveRunOptions.Live(value);

public static LiveRunOptions Live(LiveRunOptions liveRunOptions) #

Sets LiveRunOptions.Live to true.

Parameters

liveRunOptions ConsoleMonster.Live.LiveRunOptions required: The instance to configure.

Returns

LiveRunOptions The same instance.

public static LiveSessionOptions Live(LiveSessionOptions liveSessionOptions, bool value) #

Sets LiveSessionOptions.Live: Allows live rendering when the terminal supports it; false selects append-only output.

Parameters

liveSessionOptions ConsoleMonster.Live.LiveSessionOptions required: The instance.
value bool required: The value.

Returns

LiveSessionOptions The same instance.

Examples

// C# initializer or property                                           // C# fluent
new global::ConsoleMonster.Live.LiveSessionOptions { Live = value };    liveSessionOptions.Live(value);

public static LiveSessionOptions Live(LiveSessionOptions liveSessionOptions) #

Sets LiveSessionOptions.Live to true.

Parameters

liveSessionOptions ConsoleMonster.Live.LiveSessionOptions required: The instance to configure.

Returns

LiveSessionOptions The same instance.

public static RunOptions Live(RunOptions runOptions, bool? value) #

Sets RunOptions.Live: Whether to show the live view (true), print a line per item (false) or decide from the terminal (null, default).

Parameters

runOptions ConsoleMonster.Live.RunOptions required: The instance.
value bool? required: The value.

Returns

RunOptions The same instance.

Examples

// C# initializer or property                                   // C# fluent
new global::ConsoleMonster.Live.RunOptions { Live = value };    runOptions.Live(value);

public static WatchOptions Live(WatchOptions watchOptions, bool? value) #

Sets WatchOptions.Live: Whether to show a live view (true), print each run (false), or decide from the terminal (null, default): a live view only on an interactive terminal.

Parameters

watchOptions ConsoleMonster.Live.WatchOptions required: The instance.
value bool? required: The value.

Returns

WatchOptions The same instance.

Examples

// C# initializer or property                                     // C# fluent
new global::ConsoleMonster.Live.WatchOptions { Live = value };    watchOptions.Live(value);

public static LiveSessionOptions LogTarget(LiveSessionOptions liveSessionOptions, string? value) #

Sets LiveSessionOptions.LogTarget: Name of the log target, or null to discover the first log target.

Parameters

liveSessionOptions ConsoleMonster.Live.LiveSessionOptions required: The instance.
value string? required: The value.

Returns

LiveSessionOptions The same instance.

Examples

// C# initializer or property                                                // C# fluent
new global::ConsoleMonster.Live.LiveSessionOptions { LogTarget = value };    liveSessionOptions.LogTarget(value);

public static LiveSessionOptions Mode(LiveSessionOptions liveSessionOptions, LiveMode value) #

Sets LiveSessionOptions.Mode: Full screen (default) or an inline area below the cursor. Without a VT console (CI, redirected output) both fall back to stream lines.

Parameters

liveSessionOptions ConsoleMonster.Live.LiveSessionOptions required: The instance.
value ConsoleMonster.Live.LiveMode required: The value.

Returns

LiveSessionOptions The same instance.

Examples

// C# initializer or property                                           // C# fluent
new global::ConsoleMonster.Live.LiveSessionOptions { Mode = value };    liveSessionOptions.Mode(value);

public static WidgetUpdate NodeKey(WidgetUpdate widgetUpdate, string? value) #

Sets WidgetUpdate.NodeKey: The flow node to update; exclusive with EdgeKey.

Parameters

widgetUpdate ConsoleMonster.Live.WidgetUpdate required: The instance.
value string? required: The value.

Returns

WidgetUpdate The same instance.

Examples

// C# initializer or property                                        // C# fluent
new global::ConsoleMonster.Live.WidgetUpdate { NodeKey = value };    widgetUpdate.NodeKey(value);

NotifyOnFinish 2 overloads

public static LiveSessionOptions NotifyOnFinish(LiveSessionOptions liveSessionOptions, bool value) #

Sets LiveSessionOptions.NotifyOnFinish: Whether the session rings the terminal bell when it ends, to call attention to a finished run (default false).

Parameters

liveSessionOptions ConsoleMonster.Live.LiveSessionOptions required: The instance.
value bool required: The value.

Returns

LiveSessionOptions The same instance.

Examples

// C# initializer or property                                                     // C# fluent
new global::ConsoleMonster.Live.LiveSessionOptions { NotifyOnFinish = value };    liveSessionOptions.NotifyOnFinish(value);

public static LiveSessionOptions NotifyOnFinish(LiveSessionOptions liveSessionOptions) #

Sets LiveSessionOptions.NotifyOnFinish to true.

Parameters

liveSessionOptions ConsoleMonster.Live.LiveSessionOptions required: The instance to configure.

Returns

LiveSessionOptions The same instance.

public static LiveSessionOptions Output(LiveSessionOptions liveSessionOptions, ITerminalOutput? value) #

Sets LiveSessionOptions.Output: Borrowed output, or null to create and own the terminal output.

Parameters

liveSessionOptions ConsoleMonster.Live.LiveSessionOptions required: The instance.
value ConsoleMonster.Rendering.ITerminalOutput? required: The value.

Returns

LiveSessionOptions The same instance.

Examples

// C# initializer or property                                             // C# fluent
new global::ConsoleMonster.Live.LiveSessionOptions { Output = value };    liveSessionOptions.Output(value);

public static WidgetUpdate ParentKey(WidgetUpdate widgetUpdate, string? value) #

Sets WidgetUpdate.ParentKey: The parent activity key.

Parameters

widgetUpdate ConsoleMonster.Live.WidgetUpdate required: The instance.
value string? required: The value.

Returns

WidgetUpdate The same instance.

Examples

// C# initializer or property                                          // C# fluent
new global::ConsoleMonster.Live.WidgetUpdate { ParentKey = value };    widgetUpdate.ParentKey(value);

public static WatchOptions PollInterval(WatchOptions watchOptions, TimeSpan value) #

Sets WatchOptions.PollInterval: The time between the end of one run and the start of the next (default 2 seconds, at least 50 ms).

Parameters

watchOptions ConsoleMonster.Live.WatchOptions required: The instance.
value System.TimeSpan required: The value.

Returns

WatchOptions The same instance.

Examples

// C# initializer or property                                             // C# fluent
new global::ConsoleMonster.Live.WatchOptions { PollInterval = value };    watchOptions.PollInterval(value);

PrintFinalState 2 overloads

public static LiveSessionOptions PrintFinalState(LiveSessionOptions liveSessionOptions, bool value) #

Sets LiveSessionOptions.PrintFinalState: When no LiveSessionOptions.Summary is set, print the final state of the root widget to scrollback after the session ends (default true), so a live dashboard always leaves a record behind.

Parameters

liveSessionOptions ConsoleMonster.Live.LiveSessionOptions required: The instance.
value bool required: The value.

Returns

LiveSessionOptions The same instance.

Examples

// C# initializer or property                                                      // C# fluent
new global::ConsoleMonster.Live.LiveSessionOptions { PrintFinalState = value };    liveSessionOptions.PrintFinalState(value);

public static LiveSessionOptions PrintFinalState(LiveSessionOptions liveSessionOptions) #

Sets LiveSessionOptions.PrintFinalState to true.

Parameters

liveSessionOptions ConsoleMonster.Live.LiveSessionOptions required: The instance to configure.

Returns

LiveSessionOptions The same instance.

public static LiveSessionOptions Profile(LiveSessionOptions liveSessionOptions, TerminalProfile? value) #

Sets LiveSessionOptions.Profile: Profile override, or null for Terminal.Profile.

Parameters

liveSessionOptions ConsoleMonster.Live.LiveSessionOptions required: The instance.
value ConsoleMonster.Capabilities.TerminalProfile? required: The value.

Returns

LiveSessionOptions The same instance.

Examples

// C# initializer or property                                              // C# fluent
new global::ConsoleMonster.Live.LiveSessionOptions { Profile = value };    liveSessionOptions.Profile(value);

public static LiveRunOptions ProgressEvery(LiveRunOptions liveRunOptions, int value) #

Sets LiveRunOptions.ProgressEvery: In append-only mode, emit progress after this many completions. Zero disables the count trigger.

Parameters

liveRunOptions ConsoleMonster.Live.LiveRunOptions required: The instance.
value int required: The value.

Returns

LiveRunOptions The same instance.

Examples

// C# initializer or property                                                // C# fluent
new global::ConsoleMonster.Live.LiveRunOptions { ProgressEvery = value };    liveRunOptions.ProgressEvery(value);

public static LiveRunOptions ProgressInterval(LiveRunOptions liveRunOptions, TimeSpan value) #

Sets LiveRunOptions.ProgressInterval: In append-only mode, emit progress at this interval even while items are slow. Zero disables the time trigger.

Parameters

liveRunOptions ConsoleMonster.Live.LiveRunOptions required: The instance.
value System.TimeSpan required: The value.

Returns

LiveRunOptions The same instance.

Examples

// C# initializer or property                                                   // C# fluent
new global::ConsoleMonster.Live.LiveRunOptions { ProgressInterval = value };    liveRunOptions.ProgressInterval(value);

public static LiveSessionOptions RecordingName(LiveSessionOptions liveSessionOptions, string? value) #

Sets LiveSessionOptions.RecordingName: The name automatic recordings start with (default session), followed by the start time.

Parameters

liveSessionOptions ConsoleMonster.Live.LiveSessionOptions required: The instance.
value string? required: The value.

Returns

LiveSessionOptions The same instance.

Examples

// C# initializer or property                                                    // C# fluent
new global::ConsoleMonster.Live.LiveSessionOptions { RecordingName = value };    liveSessionOptions.RecordingName(value);

public static LiveSessionOptions RecordPath(LiveSessionOptions liveSessionOptions, string? value) #

Sets LiveSessionOptions.RecordPath: UTF-8 recording destination, mutually exclusive with RecordWriter.

Parameters

liveSessionOptions ConsoleMonster.Live.LiveSessionOptions required: The instance.
value string? required: The value.

Returns

LiveSessionOptions The same instance.

Examples

// C# initializer or property                                                 // C# fluent
new global::ConsoleMonster.Live.LiveSessionOptions { RecordPath = value };    liveSessionOptions.RecordPath(value);

public static LiveSessionOptions RecordWriter(LiveSessionOptions liveSessionOptions, TextWriter? value) #

Sets LiveSessionOptions.RecordWriter: Borrowed recording writer; flushed but left open at shutdown.

Parameters

liveSessionOptions ConsoleMonster.Live.LiveSessionOptions required: The instance.
value System.IO.TextWriter? required: The value.

Returns

LiveSessionOptions The same instance.

Examples

// C# initializer or property                                                   // C# fluent
new global::ConsoleMonster.Live.LiveSessionOptions { RecordWriter = value };    liveSessionOptions.RecordWriter(value);

public static WidgetUpdate Remaining(WidgetUpdate widgetUpdate, TimeSpan? value) #

Sets WidgetUpdate.Remaining: The estimated time remaining on an activity.

Parameters

widgetUpdate ConsoleMonster.Live.WidgetUpdate required: The instance.
value System.TimeSpan? required: The value.

Returns

WidgetUpdate The same instance.

Examples

// C# initializer or property                                          // C# fluent
new global::ConsoleMonster.Live.WidgetUpdate { Remaining = value };    widgetUpdate.Remaining(value);

RemoveRow 2 overloads

public static WidgetUpdate RemoveRow(WidgetUpdate widgetUpdate, bool value) #

Sets WidgetUpdate.RemoveRow: Whether to remove the row addressed by Key.

Parameters

widgetUpdate ConsoleMonster.Live.WidgetUpdate required: The instance.
value bool required: The value.

Returns

WidgetUpdate The same instance.

Examples

// C# initializer or property                                          // C# fluent
new global::ConsoleMonster.Live.WidgetUpdate { RemoveRow = value };    widgetUpdate.RemoveRow(value);

public static WidgetUpdate RemoveRow(WidgetUpdate widgetUpdate) #

Sets WidgetUpdate.RemoveRow to true.

Parameters

widgetUpdate ConsoleMonster.Live.WidgetUpdate required: The instance to configure.

Returns

WidgetUpdate The same instance.

public static LiveRunOptions ReportPath(LiveRunOptions liveRunOptions, string? value) #

Sets LiveRunOptions.ReportPath: Optional report location included in the final summary.

Parameters

liveRunOptions ConsoleMonster.Live.LiveRunOptions required: The instance.
value string? required: The value.

Returns

LiveRunOptions The same instance.

Examples

// C# initializer or property                                             // C# fluent
new global::ConsoleMonster.Live.LiveRunOptions { ReportPath = value };    liveRunOptions.ReportPath(value);

Restart 2 overloads

public static WidgetUpdate Restart(WidgetUpdate widgetUpdate, bool value) #

Sets WidgetUpdate.Restart: Whether to restart a spinner.

Parameters

widgetUpdate ConsoleMonster.Live.WidgetUpdate required: The instance.
value bool required: The value.

Returns

WidgetUpdate The same instance.

Examples

// C# initializer or property                                        // C# fluent
new global::ConsoleMonster.Live.WidgetUpdate { Restart = value };    widgetUpdate.Restart(value);

public static WidgetUpdate Restart(WidgetUpdate widgetUpdate) #

Sets WidgetUpdate.Restart to true.

Parameters

widgetUpdate ConsoleMonster.Live.WidgetUpdate required: The instance to configure.

Returns

WidgetUpdate The same instance.

public static WidgetUpdate Result(WidgetUpdate widgetUpdate, StatusKind value) #

Sets WidgetUpdate.Result: The result of completed lane steps.

Parameters

widgetUpdate ConsoleMonster.Live.WidgetUpdate required: The instance.
value ConsoleMonster.Styling.StatusKind required: The value.

Returns

WidgetUpdate The same instance.

Examples

// C# initializer or property                                       // C# fluent
new global::ConsoleMonster.Live.WidgetUpdate { Result = value };    widgetUpdate.Result(value);

public static RunOptions RetryCount(RunOptions runOptions, int value) #

Sets RunOptions.RetryCount: How many more times a failed or timed-out item runs before it counts as failed (default 0). Cancelling the run does not retry.

Parameters

runOptions ConsoleMonster.Live.RunOptions required: The instance.
value int required: The value.

Returns

RunOptions The same instance.

Examples

// C# initializer or property                                         // C# fluent
new global::ConsoleMonster.Live.RunOptions { RetryCount = value };    runOptions.RetryCount(value);

public static RunOptions RetryDelay(RunOptions runOptions, TimeSpan value) #

Sets RunOptions.RetryDelay: The pause before each retry (default none).

Parameters

runOptions ConsoleMonster.Live.RunOptions required: The instance.
value System.TimeSpan required: The value.

Returns

RunOptions The same instance.

Examples

// C# initializer or property                                         // C# fluent
new global::ConsoleMonster.Live.RunOptions { RetryDelay = value };    runOptions.RetryDelay(value);

Row 2 overloads

public static WidgetUpdate Row(WidgetUpdate widgetUpdate, ConsoleTableRow? value) #

Sets WidgetUpdate.Row: A keyed table row with typed cells.

Parameters

widgetUpdate ConsoleMonster.Live.WidgetUpdate required: The instance.
value ConsoleMonster.Live.ConsoleTableRow? required: The value.

Returns

WidgetUpdate The same instance.

Examples

// C# initializer or property                                    // C# fluent
new global::ConsoleMonster.Live.WidgetUpdate { Row = value };    widgetUpdate.Row(value);

public static WidgetUpdate Row(WidgetUpdate widgetUpdate, Action<ConsoleTableRow> configure) #

Configures WidgetUpdate.Row in place (creating it when not set): A keyed table row with typed cells.

Parameters

widgetUpdate ConsoleMonster.Live.WidgetUpdate required: The instance.
configure System.Action<ConsoleMonster.Live.ConsoleTableRow> required: Configures the value.

Returns

WidgetUpdate The same instance.

Session 6 overloads

public static LiveRunOptions Session(LiveRunOptions liveRunOptions, LiveSessionOptions? value) #

Sets LiveRunOptions.Session: Exclusive configuration for this run's target, output, theme and capture. Do not share it with another session. The run sets inline mode, cooperative cancellation, ten frames per second, height limit and final summary.

Parameters

liveRunOptions ConsoleMonster.Live.LiveRunOptions required: The instance.
value ConsoleMonster.Live.LiveSessionOptions? required: The value.

Returns

LiveRunOptions The same instance.

Examples

// C# initializer or property                                          // C# fluent
new global::ConsoleMonster.Live.LiveRunOptions { Session = value };    liveRunOptions.Session(value);

public static LiveRunOptions Session(LiveRunOptions liveRunOptions, Action<LiveSessionOptions> configure) #

Configures LiveRunOptions.Session in place (creating it when not set): Exclusive configuration for this run's target, output, theme and capture. Do not share it with another session. The run sets inline mode, cooperative cancellation, ten frames per second, height limit and final summary.

Parameters

liveRunOptions ConsoleMonster.Live.LiveRunOptions required: The instance.
configure System.Action<ConsoleMonster.Live.LiveSessionOptions> required: Configures the value.

Returns

LiveRunOptions The same instance.

public static RunOptions Session(RunOptions runOptions, LiveSessionOptions? value) #

Sets RunOptions.Session: The live session's options (inline with the final frame kept, by default).

Parameters

runOptions ConsoleMonster.Live.RunOptions required: The instance.
value ConsoleMonster.Live.LiveSessionOptions? required: The value.

Returns

RunOptions The same instance.

Examples

// C# initializer or property                                      // C# fluent
new global::ConsoleMonster.Live.RunOptions { Session = value };    runOptions.Session(value);

public static RunOptions Session(RunOptions runOptions, Action<LiveSessionOptions> configure) #

Configures RunOptions.Session in place (creating it when not set): The live session's options (inline with the final frame kept, by default).

Parameters

runOptions ConsoleMonster.Live.RunOptions required: The instance.
configure System.Action<ConsoleMonster.Live.LiveSessionOptions> required: Configures the value.

Returns

RunOptions The same instance.

public static WatchOptions Session(WatchOptions watchOptions, LiveSessionOptions? value) #

Sets WatchOptions.Session: The live session's options for the interactive view (inline with the final frame kept, by default).

Parameters

watchOptions ConsoleMonster.Live.WatchOptions required: The instance.
value ConsoleMonster.Live.LiveSessionOptions? required: The value.

Returns

WatchOptions The same instance.

Examples

// C# initializer or property                                        // C# fluent
new global::ConsoleMonster.Live.WatchOptions { Session = value };    watchOptions.Session(value);

public static WatchOptions Session(WatchOptions watchOptions, Action<LiveSessionOptions> configure) #

Configures WatchOptions.Session in place (creating it when not set): The live session's options for the interactive view (inline with the final frame kept, by default).

Parameters

watchOptions ConsoleMonster.Live.WatchOptions required: The instance.
configure System.Action<ConsoleMonster.Live.LiveSessionOptions> required: Configures the value.

Returns

WatchOptions The same instance.

ShowGroups 2 overloads

public static LiveRunOptions ShowGroups(LiveRunOptions liveRunOptions, bool value) #

Sets LiveRunOptions.ShowGroups: Show category progress when spare height is available.

Parameters

liveRunOptions ConsoleMonster.Live.LiveRunOptions required: The instance.
value bool required: The value.

Returns

LiveRunOptions The same instance.

Examples

// C# initializer or property                                             // C# fluent
new global::ConsoleMonster.Live.LiveRunOptions { ShowGroups = value };    liveRunOptions.ShowGroups(value);

public static LiveRunOptions ShowGroups(LiveRunOptions liveRunOptions) #

Sets LiveRunOptions.ShowGroups to true.

Parameters

liveRunOptions ConsoleMonster.Live.LiveRunOptions required: The instance to configure.

Returns

LiveRunOptions The same instance.

ShowTrend 2 overloads

public static LiveRunOptions ShowTrend(LiveRunOptions liveRunOptions, bool value) #

Sets LiveRunOptions.ShowTrend: Show a short throughput trend next to the rate.

Parameters

liveRunOptions ConsoleMonster.Live.LiveRunOptions required: The instance.
value bool required: The value.

Returns

LiveRunOptions The same instance.

Examples

// C# initializer or property                                            // C# fluent
new global::ConsoleMonster.Live.LiveRunOptions { ShowTrend = value };    liveRunOptions.ShowTrend(value);

public static LiveRunOptions ShowTrend(LiveRunOptions liveRunOptions) #

Sets LiveRunOptions.ShowTrend to true.

Parameters

liveRunOptions ConsoleMonster.Live.LiveRunOptions required: The instance to configure.

Returns

LiveRunOptions The same instance.

Status 2 overloads

public static WidgetUpdate Status(WidgetUpdate widgetUpdate, StatusKind value) #

Sets WidgetUpdate.Status: The new state.

Parameters

widgetUpdate ConsoleMonster.Live.WidgetUpdate required: The instance.
value ConsoleMonster.Styling.StatusKind required: The value.

Returns

WidgetUpdate The same instance.

Examples

// C# initializer or property                                       // C# fluent
new global::ConsoleMonster.Live.WidgetUpdate { Status = value };    widgetUpdate.Status(value);

public static RunUpdate Status(RunUpdate runUpdate, StatusKind value) #

Sets RunUpdate.Status: Running, Pass, Fail, Warn or Skip.

Parameters

runUpdate ConsoleMonster.Live.RunUpdate required: The instance.
value ConsoleMonster.Styling.StatusKind required: The value.

Returns

RunUpdate The same instance.

Examples

// C# initializer or property                                    // C# fluent
new global::ConsoleMonster.Live.RunUpdate { Status = value };    runUpdate.Status(value);

StopOnCancellation 2 overloads

public static LiveSessionOptions StopOnCancellation(LiveSessionOptions liveSessionOptions, bool value) #

Sets LiveSessionOptions.StopOnCancellation: Stop drawing immediately on cooperative cancellation (default true). False leaves output open until Stop, allowing a runner to drain worker results before its final summary.

Parameters

liveSessionOptions ConsoleMonster.Live.LiveSessionOptions required: The instance.
value bool required: The value.

Returns

LiveSessionOptions The same instance.

Examples

// C# initializer or property                                                         // C# fluent
new global::ConsoleMonster.Live.LiveSessionOptions { StopOnCancellation = value };    liveSessionOptions.StopOnCancellation(value);

public static LiveSessionOptions StopOnCancellation(LiveSessionOptions liveSessionOptions) #

Sets LiveSessionOptions.StopOnCancellation to true.

Parameters

liveSessionOptions ConsoleMonster.Live.LiveSessionOptions required: The instance to configure.

Returns

LiveSessionOptions The same instance.

public static LiveSessionOptions StopTimeout(LiveSessionOptions liveSessionOptions, TimeSpan value) #

Sets LiveSessionOptions.StopTimeout: Maximum render-thread join wait; defaults to two seconds. Must be between zero and Int32.MaxValue milliseconds.

Parameters

liveSessionOptions ConsoleMonster.Live.LiveSessionOptions required: The instance.
value System.TimeSpan required: The value.

Returns

LiveSessionOptions The same instance.

Examples

// C# initializer or property                                                  // C# fluent
new global::ConsoleMonster.Live.LiveSessionOptions { StopTimeout = value };    liveSessionOptions.StopTimeout(value);

public static LiveSessionOptions StreamHeartbeat(LiveSessionOptions liveSessionOptions, TimeSpan value) #

Sets LiveSessionOptions.StreamHeartbeat: Interval between line-mode summaries; defaults to ten seconds. Zero disables them.

Parameters

liveSessionOptions ConsoleMonster.Live.LiveSessionOptions required: The instance.
value System.TimeSpan required: The value.

Returns

LiveSessionOptions The same instance.

Examples

// C# initializer or property                                                      // C# fluent
new global::ConsoleMonster.Live.LiveSessionOptions { StreamHeartbeat = value };    liveSessionOptions.StreamHeartbeat(value);

public static LiveSessionOptions StreamTimestamps(LiveSessionOptions liveSessionOptions, bool? value) #

Sets LiveSessionOptions.StreamTimestamps: Prefixes each line-mode narration and heartbeat line with the session clock ([mm:ss], or [h:mm:ss] past an hour). Null (the default) enables it when the profile detected a CI environment, where log viewers often lack their own per-line timestamps; true or false forces it. Interactive frames are unaffected.

Parameters

liveSessionOptions ConsoleMonster.Live.LiveSessionOptions required: The instance.
value bool? required: The value.

Returns

LiveSessionOptions The same instance.

Examples

// C# initializer or property                                                       // C# fluent
new global::ConsoleMonster.Live.LiveSessionOptions { StreamTimestamps = value };    liveSessionOptions.StreamTimestamps(value);

public static LiveSessionOptions Summary(LiveSessionOptions liveSessionOptions, IWidget? value) #

Sets LiveSessionOptions.Summary: Widget appended to scrollback after live output ends.

Parameters

liveSessionOptions ConsoleMonster.Live.LiveSessionOptions required: The instance.
value ConsoleMonster.Layout.IWidget? required: The value.

Returns

LiveSessionOptions The same instance.

Examples

// C# initializer or property                                              // C# fluent
new global::ConsoleMonster.Live.LiveSessionOptions { Summary = value };    liveSessionOptions.Summary(value);

public static LiveSessionOptions Target(LiveSessionOptions liveSessionOptions, ITerminalTarget? value) #

Sets LiveSessionOptions.Target: Where the session draws: its profile, theme and writer (see ITerminalTarget), or null for Terminal.Target at start. LiveSessionOptions.Profile, LiveSessionOptions.Theme and LiveSessionOptions.Output still win when set. Only the console target claims the console, probes widths and watches the font.

Parameters

liveSessionOptions ConsoleMonster.Live.LiveSessionOptions required: The instance.
value ConsoleMonster.Output.ITerminalTarget? required: The value.

Returns

LiveSessionOptions The same instance.

Examples

// C# initializer or property                                             // C# fluent
new global::ConsoleMonster.Live.LiveSessionOptions { Target = value };    liveSessionOptions.Target(value);

TaskbarProgress 2 overloads

public static LiveSessionOptions TaskbarProgress(LiveSessionOptions liveSessionOptions, bool value) #

Sets LiveSessionOptions.TaskbarProgress: Whether the session drives the terminal's progress indicator (the Windows Terminal tab and taskbar) from its progress bars, lanes, spinners and status, and clears it at the end (default true; see LiveSessionOptions.TaskbarProgress).

Parameters

liveSessionOptions ConsoleMonster.Live.LiveSessionOptions required: The instance.
value bool required: The value.

Returns

LiveSessionOptions The same instance.

Examples

// C# initializer or property                                                      // C# fluent
new global::ConsoleMonster.Live.LiveSessionOptions { TaskbarProgress = value };    liveSessionOptions.TaskbarProgress(value);

public static LiveSessionOptions TaskbarProgress(LiveSessionOptions liveSessionOptions) #

Sets LiveSessionOptions.TaskbarProgress to true.

Parameters

liveSessionOptions ConsoleMonster.Live.LiveSessionOptions required: The instance to configure.

Returns

LiveSessionOptions The same instance.

public static LiveSessionOptions Theme(LiveSessionOptions liveSessionOptions, ITheme? value) #

Sets LiveSessionOptions.Theme: Theme override, or null for Terminal.Theme.

Parameters

liveSessionOptions ConsoleMonster.Live.LiveSessionOptions required: The instance.
value ConsoleMonster.Styling.ITheme? required: The value.

Returns

LiveSessionOptions The same instance.

Examples

// C# initializer or property                                            // C# fluent
new global::ConsoleMonster.Live.LiveSessionOptions { Theme = value };    liveSessionOptions.Theme(value);

public static RunOptions ThrottleLimit(RunOptions runOptions, int value) #

Sets RunOptions.ThrottleLimit: How many items run at the same time (default the processor count).

Parameters

runOptions ConsoleMonster.Live.RunOptions required: The instance.
value int required: The value.

Returns

RunOptions The same instance.

Examples

// C# initializer or property                                            // C# fluent
new global::ConsoleMonster.Live.RunOptions { ThrottleLimit = value };    runOptions.ThrottleLimit(value);

public static RunOptions Timeout(RunOptions runOptions, TimeSpan? value) #

Sets RunOptions.Timeout: The time one item may take, or null for no limit; an item past it is cancelled and counts as failed.

Parameters

runOptions ConsoleMonster.Live.RunOptions required: The instance.
value System.TimeSpan? required: The value.

Returns

RunOptions The same instance.

Examples

// C# initializer or property                                      // C# fluent
new global::ConsoleMonster.Live.RunOptions { Timeout = value };    runOptions.Timeout(value);

Title 3 overloads

public static LiveRunOptions Title(LiveRunOptions liveRunOptions, string value) #

Sets LiveRunOptions.Title: The literal run name.

Parameters

liveRunOptions ConsoleMonster.Live.LiveRunOptions required: The instance.
value string required: The value.

Returns

LiveRunOptions The same instance.

Examples

// C# initializer or property                                        // C# fluent
new global::ConsoleMonster.Live.LiveRunOptions { Title = value };    liveRunOptions.Title(value);

public static RunOptions Title(RunOptions runOptions, string? value) #

Sets RunOptions.Title: A title above the live view (markup), or null.

Parameters

runOptions ConsoleMonster.Live.RunOptions required: The instance.
value string? required: The value.

Returns

RunOptions The same instance.

Examples

// C# initializer or property                                    // C# fluent
new global::ConsoleMonster.Live.RunOptions { Title = value };    runOptions.Title(value);

public static WatchOptions Title(WatchOptions watchOptions, string? value) #

Sets WatchOptions.Title: What is being watched, shown in the heading (markup), or null.

Parameters

watchOptions ConsoleMonster.Live.WatchOptions required: The instance.
value string? required: The value.

Returns

WatchOptions The same instance.

Examples

// C# initializer or property                                      // C# fluent
new global::ConsoleMonster.Live.WatchOptions { Title = value };    watchOptions.Title(value);

public static WidgetUpdate Total(WidgetUpdate widgetUpdate, double value) #

Sets WidgetUpdate.Total: The planned total; zero represents an unknown total.

Parameters

widgetUpdate ConsoleMonster.Live.WidgetUpdate required: The instance.
value double required: The value.

Returns

WidgetUpdate The same instance.

Examples

// C# initializer or property                                      // C# fluent
new global::ConsoleMonster.Live.WidgetUpdate { Total = value };    widgetUpdate.Total(value);

public static WidgetUpdate Value(WidgetUpdate widgetUpdate, object? value) #

Sets WidgetUpdate.Value: The absolute value, retaining its original scalar type.

Parameters

widgetUpdate ConsoleMonster.Live.WidgetUpdate required: The instance.
value object? required: The value.

Returns

WidgetUpdate The same instance.

Examples

// C# initializer or property                                      // C# fluent
new global::ConsoleMonster.Live.WidgetUpdate { Value = value };    widgetUpdate.Value(value);

public static ConsoleTableRow Values(ConsoleTableRow consoleTableRow, object?[] value) #

Sets ConsoleTableRow.Values: Typed cell values, in column order.

Parameters

consoleTableRow ConsoleMonster.Live.ConsoleTableRow required: The instance.
value object?[] required: The value.

Returns

ConsoleTableRow The same instance.

Examples

// C# initializer or property                                          // C# fluent
new global::ConsoleMonster.Live.ConsoleTableRow { Values = value };    consoleTableRow.Values(value);

Inheritance

Methods

Inherited Methods