Class

LiveSessionOptionsFluent

ConsoleMonster.Live

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

The fluent methods of LiveSessionOptions, 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
LiveSessionOptionsFluent

Methods

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 };    Ui.Options<global::ConsoleMonster.Live.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 };    Ui.Options<global::ConsoleMonster.Live.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 };    Ui.Options<global::ConsoleMonster.Live.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 };    Ui.Options<global::ConsoleMonster.Live.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 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 };    Ui.Options<global::ConsoleMonster.Live.LiveSessionOptions>().Configure(configured => configured.Clock = value);

// C# initializer or property                                                  // C# fluent
new global::ConsoleMonster.Live.LiveSessionOptions { ReplayDelay = value };    Ui.Options<global::ConsoleMonster.Live.LiveSessionOptions>().Configure(configured => configured.ReplayDelay = 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 };    Ui.Options<global::ConsoleMonster.Live.LiveSessionOptions>().Culture(value);

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 };    Ui.Options<global::ConsoleMonster.Live.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 LiveSessionOptions FramesPerSecond(LiveSessionOptions liveSessionOptions, int value) #

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

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 { FramesPerSecond = value };    Ui.Options<global::ConsoleMonster.Live.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 };    Ui.Options<global::ConsoleMonster.Live.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 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 };    Ui.Options<global::ConsoleMonster.Live.LiveSessionOptions>().InlineHeightFraction(value);

Live 2 overloads

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 };    Ui.Options<global::ConsoleMonster.Live.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 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 };    Ui.Options<global::ConsoleMonster.Live.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 };    Ui.Options<global::ConsoleMonster.Live.LiveSessionOptions>().Mode(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 };    Ui.Options<global::ConsoleMonster.Live.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 };    Ui.Options<global::ConsoleMonster.Live.LiveSessionOptions>().Output(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 };    Ui.Options<global::ConsoleMonster.Live.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 };    Ui.Options<global::ConsoleMonster.Live.LiveSessionOptions>().Profile(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 };    Ui.Options<global::ConsoleMonster.Live.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 };    Ui.Options<global::ConsoleMonster.Live.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 };    Ui.Options<global::ConsoleMonster.Live.LiveSessionOptions>().RecordWriter(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 };    Ui.Options<global::ConsoleMonster.Live.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 };    Ui.Options<global::ConsoleMonster.Live.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 };    Ui.Options<global::ConsoleMonster.Live.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 };    Ui.Options<global::ConsoleMonster.Live.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 };    Ui.Options<global::ConsoleMonster.Live.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 };    Ui.Options<global::ConsoleMonster.Live.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 };    Ui.Options<global::ConsoleMonster.Live.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 };    Ui.Options<global::ConsoleMonster.Live.LiveSessionOptions>().Theme(value);

Inheritance

Methods

Inherited Methods