Skip to content
ConsoleMonster
Class

WatchOptionsFluent

ConsoleMonster.Live

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

The fluent methods of WatchOptions, 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
  • WatchOptionsFluent

Methods

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 };    Ui.Options<global::ConsoleMonster.Live.WatchOptions>().Configure(configured => configured.Print = value);
// C# initializer or property                                      // C# fluent
new global::ConsoleMonster.Live.WatchOptions { Delay = value };    Ui.Options<global::ConsoleMonster.Live.WatchOptions>().Configure(configured => configured.Delay = 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 };    Ui.Options<global::ConsoleMonster.Live.WatchOptions>().Count(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 };    Ui.Options<global::ConsoleMonster.Live.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.
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 };    Ui.Options<global::ConsoleMonster.Live.WatchOptions>().Live(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 };    Ui.Options<global::ConsoleMonster.Live.WatchOptions>().PollInterval(value);
Session 2 overloads
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 };    Ui.Options<global::ConsoleMonster.Live.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.
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 };    Ui.Options<global::ConsoleMonster.Live.WatchOptions>().Title(value);