Class

CommandOptions

ConsoleMonster.Interactive

Edit on GitHub

Namespace: ConsoleMonster.Interactive
Assembly: ConsoleMonster
Source: CommandOptions.cs:10
Modifiers: sealed

Configuration for an action whose identity and callback become immutable at Build.

Inheritance

object
CommandOptions

Usage

Explore 25 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by 11

Extension method CommandOptions.Configure
Extension method CommandOptions.ConfirmPrompt
Extension method CommandOptions.Key
Extension method CommandOptions.Label
Extension method CommandOptions.Shortcut
Method CommandOptionsFluent.Configure
Method CommandOptionsFluent.ConfirmPrompt
Method CommandOptionsFluent.Key
Method CommandOptionsFluent.Label
Method CommandOptionsFluent.Shortcut
Method Ui.Command

Accepted by parameters 14

Extension method CommandOptions.Build parameter options
Extension method CommandOptions.Configure parameter commandOptions
Extension method CommandOptions.Configure parameter configure
Extension method CommandOptions.ConfirmPrompt parameter commandOptions
Extension method CommandOptions.Key parameter commandOptions
Extension method CommandOptions.Label parameter commandOptions
Extension method CommandOptions.Shortcut parameter commandOptions
Method CommandOptionsFluent.Configure parameter commandOptions
Method CommandOptionsFluent.Configure parameter configure
Method CommandOptionsFluent.ConfirmPrompt parameter commandOptions
Method CommandOptionsFluent.Key parameter commandOptions
Method CommandOptionsFluent.Label parameter commandOptions
Method CommandOptionsFluent.Shortcut parameter commandOptions
Method UiConstruction.Build parameter options

Constructors

public CommandOptions() #

CommandOptions.cs:10

Inherited Methods

Properties

public string Key { get; set; } #

CommandOptions.cs:10

The stable command key.

public string? Label { get; set; } #

CommandOptions.cs:12

The visible label; null uses Key.

public Func<AppActionContext, CancellationToken, Task>? Action { get; set; } #

CommandOptions.cs:14

The asynchronous operation over captured rows and cancellation.

public KeyChord? Shortcut { get; set; } #

CommandOptions.cs:16

The optional keyboard shortcut.

public string? ConfirmPrompt { get; set; } #

CommandOptions.cs:18

The optional confirmation prompt.

Extension Methods

public static AppCommand Build(CommandOptions options) #

Ui.Construction.cs:32

Creates an asynchronous action after its immutable identity and callback have been configured.

Parameters

options ConsoleMonster.Interactive.CommandOptions required: The configured definition.

Returns

AppCommand The command.

public static CommandOptions Configure(CommandOptions commandOptions, Action<CommandOptions> configure) #

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

Parameters

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

Returns

CommandOptions The same instance.

Examples

// C# initializer or property                                                // C# fluent
new global::ConsoleMonster.Interactive.CommandOptions { Action = value };    Ui.Command().Configure(configured => configured.Action = value);

public static CommandOptions ConfirmPrompt(CommandOptions commandOptions, string? value) #

Sets CommandOptions.ConfirmPrompt: The optional confirmation prompt.

Parameters

commandOptions ConsoleMonster.Interactive.CommandOptions required: The instance.
value string? required: The value.

Returns

CommandOptions The same instance.

Examples

// C# initializer or property                                                       // C# fluent
new global::ConsoleMonster.Interactive.CommandOptions { ConfirmPrompt = value };    Ui.Command().ConfirmPrompt(value);

public static CommandOptions Key(CommandOptions commandOptions, string value) #

Sets CommandOptions.Key: The stable command key.

Parameters

commandOptions ConsoleMonster.Interactive.CommandOptions required: The instance.
value string required: The value.

Returns

CommandOptions The same instance.

Examples

// C# initializer or property                                             // C# fluent
new global::ConsoleMonster.Interactive.CommandOptions { Key = value };    Ui.Command().Key(value);

public static CommandOptions Label(CommandOptions commandOptions, string? value) #

Sets CommandOptions.Label: The visible label; null uses Key.

Parameters

commandOptions ConsoleMonster.Interactive.CommandOptions required: The instance.
value string? required: The value.

Returns

CommandOptions The same instance.

Examples

// C# initializer or property                                               // C# fluent
new global::ConsoleMonster.Interactive.CommandOptions { Label = value };    Ui.Command().Label(value);

public static CommandOptions Shortcut(CommandOptions commandOptions, KeyChord? value) #

Sets CommandOptions.Shortcut: The optional keyboard shortcut.

Parameters

commandOptions ConsoleMonster.Interactive.CommandOptions required: The instance.
value ConsoleMonster.Input.KeyChord? required: The value.

Returns

CommandOptions The same instance.

Examples

// C# initializer or property                                                  // C# fluent
new global::ConsoleMonster.Interactive.CommandOptions { Shortcut = value };    Ui.Command().Shortcut(value);