Class

ConsoleAppOptionsFluent

ConsoleMonster.Interactive

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

The fluent methods of ConsoleAppOptions, 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
ConsoleAppOptionsFluent

Methods

AddCommand 3 overloads

public static ConsoleAppOptions AddCommand(ConsoleAppOptions consoleAppOptions, AppCommand item) #

Adds an item to ConsoleAppOptions.Command: Passive commands shared by the app's buttons, palette and keyboard shortcuts.

Parameters

consoleAppOptions ConsoleMonster.Interactive.ConsoleAppOptions required: The instance.
item ConsoleMonster.Interactive.AppCommand required: The item.

Returns

ConsoleAppOptions The same instance.

public static ConsoleAppOptions AddCommand(ConsoleAppOptions consoleAppOptions, params AppCommand[] items) #

Adds items to ConsoleAppOptions.Command: Passive commands shared by the app's buttons, palette and keyboard shortcuts.

Parameters

consoleAppOptions ConsoleMonster.Interactive.ConsoleAppOptions required: The instance.
items ConsoleMonster.Interactive.AppCommand[] required: The items, in order.

Returns

ConsoleAppOptions The same instance.

public static ConsoleAppOptions AddCommand(ConsoleAppOptions consoleAppOptions, IEnumerable<AppCommand> items) #

Adds items to ConsoleAppOptions.Command: Passive commands shared by the app's buttons, palette and keyboard shortcuts.

Parameters

consoleAppOptions ConsoleMonster.Interactive.ConsoleAppOptions required: The instance.
items System.Collections.Generic.IEnumerable<ConsoleMonster.Interactive.AppCommand> required: The items, in order.

Returns

ConsoleAppOptions The same instance.

public static ConsoleAppOptions Configure(ConsoleAppOptions consoleAppOptions, Action<ConsoleAppOptions> configure) #

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

Parameters

consoleAppOptions ConsoleMonster.Interactive.ConsoleAppOptions required: The instance.
configure System.Action<ConsoleMonster.Interactive.ConsoleAppOptions> required: Assignments applied in order.

Returns

ConsoleAppOptions The same instance.

Examples

// C# initializer or property                                                      // C# fluent
new global::ConsoleMonster.Interactive.ConsoleAppOptions { Selection = value };    Ui.Options<global::ConsoleMonster.Interactive.ConsoleAppOptions>().Configure(configured => configured.Selection = value);

// C# initializer or property                                                          // C# fluent
new global::ConsoleMonster.Interactive.ConsoleAppOptions { ProcessEvents = value };    Ui.Options<global::ConsoleMonster.Interactive.ConsoleAppOptions>().Configure(configured => configured.ProcessEvents = value);

public static ConsoleAppOptions Dispatcher(ConsoleAppOptions consoleAppOptions, AppDispatcher? value) #

Sets ConsoleAppOptions.Dispatcher: Optional mailbox for this run. The host drains it on the input thread and closes it on exit; create a new dispatcher for another run.

Parameters

consoleAppOptions ConsoleMonster.Interactive.ConsoleAppOptions required: The instance.
value ConsoleMonster.Interactive.AppDispatcher? required: The value.

Returns

ConsoleAppOptions The same instance.

Examples

// C# initializer or property                                                       // C# fluent
new global::ConsoleMonster.Interactive.ConsoleAppOptions { Dispatcher = value };    Ui.Options<global::ConsoleMonster.Interactive.ConsoleAppOptions>().Dispatcher(value);

Interactive 2 overloads

public static ConsoleAppOptions Interactive(ConsoleAppOptions consoleAppOptions, InteractiveOptions? value) #

Sets ConsoleAppOptions.Interactive: Shared prompt input, capture, capability, theme and language settings.

Parameters

consoleAppOptions ConsoleMonster.Interactive.ConsoleAppOptions required: The instance.
value ConsoleMonster.Interactive.InteractiveOptions? required: The value.

Returns

ConsoleAppOptions The same instance.

Examples

// C# initializer or property                                                        // C# fluent
new global::ConsoleMonster.Interactive.ConsoleAppOptions { Interactive = value };    Ui.Options<global::ConsoleMonster.Interactive.ConsoleAppOptions>().Interactive(value);

public static ConsoleAppOptions Interactive(ConsoleAppOptions consoleAppOptions, Action<InteractiveOptions> configure) #

Configures ConsoleAppOptions.Interactive in place (creating it when not set): Shared prompt input, capture, capability, theme and language settings.

Parameters

consoleAppOptions ConsoleMonster.Interactive.ConsoleAppOptions required: The instance.
configure System.Action<ConsoleMonster.Interactive.InteractiveOptions> required: Configures the value.

Returns

ConsoleAppOptions The same instance.

Live 2 overloads

public static ConsoleAppOptions Live(ConsoleAppOptions consoleAppOptions, LiveSessionOptions? value) #

Sets ConsoleAppOptions.Live: Optional full-screen live-session configuration, set before the run begins. Inline mode is rejected because its moving origin cannot provide frame-local mouse coordinates.

Parameters

consoleAppOptions ConsoleMonster.Interactive.ConsoleAppOptions required: The instance.
value ConsoleMonster.Live.LiveSessionOptions? required: The value.

Returns

ConsoleAppOptions The same instance.

Examples

// C# initializer or property                                                 // C# fluent
new global::ConsoleMonster.Interactive.ConsoleAppOptions { Live = value };    Ui.Options<global::ConsoleMonster.Interactive.ConsoleAppOptions>().Live(value);

public static ConsoleAppOptions Live(ConsoleAppOptions consoleAppOptions, Action<LiveSessionOptions> configure) #

Configures ConsoleAppOptions.Live in place (creating it when not set): Optional full-screen live-session configuration, set before the run begins. Inline mode is rejected because its moving origin cannot provide frame-local mouse coordinates.

Parameters

consoleAppOptions ConsoleMonster.Interactive.ConsoleAppOptions required: The instance.
configure System.Action<ConsoleMonster.Live.LiveSessionOptions> required: Configures the value.

Returns

ConsoleAppOptions The same instance.

Mouse 2 overloads

public static ConsoleAppOptions Mouse(ConsoleAppOptions consoleAppOptions, bool value) #

Sets ConsoleAppOptions.Mouse: Enables optional terminal mouse reporting for an interactive run. Keyboard operation is always available.

Parameters

consoleAppOptions ConsoleMonster.Interactive.ConsoleAppOptions required: The instance.
value bool required: The value.

Returns

ConsoleAppOptions The same instance.

Examples

// C# initializer or property                                                  // C# fluent
new global::ConsoleMonster.Interactive.ConsoleAppOptions { Mouse = value };    Ui.Options<global::ConsoleMonster.Interactive.ConsoleAppOptions>().Mouse(value);

public static ConsoleAppOptions Mouse(ConsoleAppOptions consoleAppOptions) #

Sets ConsoleAppOptions.Mouse to true.

Parameters

consoleAppOptions ConsoleMonster.Interactive.ConsoleAppOptions required: The instance to configure.

Returns

ConsoleAppOptions The same instance.

public static ConsoleAppOptions ReflowBelow(ConsoleAppOptions consoleAppOptions, int value) #

Sets ConsoleAppOptions.ReflowBelow: The default width below which column layouts stack; explicitly configured column thresholds take precedence.

Parameters

consoleAppOptions ConsoleMonster.Interactive.ConsoleAppOptions required: The instance.
value int required: The value.

Returns

ConsoleAppOptions The same instance.

Examples

// C# initializer or property                                                        // C# fluent
new global::ConsoleMonster.Interactive.ConsoleAppOptions { ReflowBelow = value };    Ui.Options<global::ConsoleMonster.Interactive.ConsoleAppOptions>().ReflowBelow(value);

public static ConsoleAppOptions SelectionKey(ConsoleAppOptions consoleAppOptions, string? value) #

Sets ConsoleAppOptions.SelectionKey: State key supplying one selected row or a collection to commands when Selection is unset.

Parameters

consoleAppOptions ConsoleMonster.Interactive.ConsoleAppOptions required: The instance.
value string? required: The value.

Returns

ConsoleAppOptions The same instance.

Examples

// C# initializer or property                                                         // C# fluent
new global::ConsoleMonster.Interactive.ConsoleAppOptions { SelectionKey = value };    Ui.Options<global::ConsoleMonster.Interactive.ConsoleAppOptions>().SelectionKey(value);

StaticSnapshot 2 overloads

public static ConsoleAppOptions StaticSnapshot(ConsoleAppOptions consoleAppOptions, bool value) #

Sets ConsoleAppOptions.StaticSnapshot: Prints or captures one initialized snapshot instead of reading input, including on CI and redirected output. CONSOLEMONSTER_SNAPSHOT=1 also selects this mode when no scripted or explicit input is available.

Parameters

consoleAppOptions ConsoleMonster.Interactive.ConsoleAppOptions required: The instance.
value bool required: The value.

Returns

ConsoleAppOptions The same instance.

Examples

// C# initializer or property                                                           // C# fluent
new global::ConsoleMonster.Interactive.ConsoleAppOptions { StaticSnapshot = value };    Ui.Options<global::ConsoleMonster.Interactive.ConsoleAppOptions>().StaticSnapshot(value);

public static ConsoleAppOptions StaticSnapshot(ConsoleAppOptions consoleAppOptions) #

Sets ConsoleAppOptions.StaticSnapshot to true.

Parameters

consoleAppOptions ConsoleMonster.Interactive.ConsoleAppOptions required: The instance to configure.

Returns

ConsoleAppOptions The same instance.

Inheritance

Methods

Inherited Methods