Class

AppHostKeys

ConsoleMonster.Interactive

Edit on GitHub

Namespace: ConsoleMonster.Interactive
Assembly: ConsoleMonster
Source: AppHostKeys.cs:8
Modifiers: sealed

Host gestures for one app. Null releases a gesture to the app registry. Ctrl+C always remains an exit/cancel fallback.

Inheritance

object
AppHostKeys

Usage

Explore 29 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 13

Extension method AppHostKeys.Actions
Extension method AppHostKeys.CancelAction
Extension method AppHostKeys.Exit
Extension method AppHostKeys.NextFocus
Extension method AppHostKeys.Palette
Extension method AppHostKeys.PreviousFocus
Method AppHostKeysFluent.Actions
Method AppHostKeysFluent.CancelAction
Method AppHostKeysFluent.Exit
Method AppHostKeysFluent.NextFocus
Method AppHostKeysFluent.Palette
Method AppHostKeysFluent.PreviousFocus
Property ConsoleAppOptions.Keys

Accepted by parameters 16

Extension method AppHostKeys.Actions parameter appHostKeys
Extension method AppHostKeys.CancelAction parameter appHostKeys
Extension method AppHostKeys.Exit parameter appHostKeys
Extension method AppHostKeys.NextFocus parameter appHostKeys
Extension method AppHostKeys.Palette parameter appHostKeys
Extension method AppHostKeys.PreviousFocus parameter appHostKeys
Method AppHostKeysFluent.Actions parameter appHostKeys
Method AppHostKeysFluent.CancelAction parameter appHostKeys
Method AppHostKeysFluent.Exit parameter appHostKeys
Method AppHostKeysFluent.NextFocus parameter appHostKeys
Method AppHostKeysFluent.Palette parameter appHostKeys
Method AppHostKeysFluent.PreviousFocus parameter appHostKeys
Extension method ConsoleAppOptions.Keys parameter configure
Extension method ConsoleAppOptions.Keys parameter value
Method ConsoleAppOptionsFluent.Keys parameter configure
Method ConsoleAppOptionsFluent.Keys parameter value

Constructors

public AppHostKeys() #

AppHostKeys.cs:8

Inherited Methods

Properties

public KeyChord? NextFocus { get; set; } #

AppHostKeys.cs:8

Focus the next input; null lets the registry claim Tab.

public KeyChord? PreviousFocus { get; set; } #

AppHostKeys.cs:10

Focus the previous input.

public KeyChord? Exit { get; set; } #

AppHostKeys.cs:12

Leave the app when the focused input does not consume this key.

public KeyChord? CancelAction { get; set; } #

AppHostKeys.cs:14

Cancel the active operation before ordinary routing. Null uses Ctrl+C alone.

public KeyChord? Palette { get; set; } #

AppHostKeys.cs:16

Open the action palette.

public KeyChord? Actions { get; set; } #

AppHostKeys.cs:18

Focus the action buttons.

Extension Methods

public static AppHostKeys Actions(AppHostKeys appHostKeys, KeyChord? value) #

Sets AppHostKeys.Actions: Focus the action buttons.

Parameters

appHostKeys ConsoleMonster.Interactive.AppHostKeys required: The instance.
value ConsoleMonster.Input.KeyChord? required: The value.

Returns

AppHostKeys The same instance.

Examples

// C# initializer or property                                              // C# fluent
new global::ConsoleMonster.Interactive.AppHostKeys { Actions = value };    appHostKeys.Actions(value);

public static AppHostKeys CancelAction(AppHostKeys appHostKeys, KeyChord? value) #

Sets AppHostKeys.CancelAction: Cancel the active operation before ordinary routing. Null uses Ctrl+C alone.

Parameters

appHostKeys ConsoleMonster.Interactive.AppHostKeys required: The instance.
value ConsoleMonster.Input.KeyChord? required: The value.

Returns

AppHostKeys The same instance.

Examples

// C# initializer or property                                                   // C# fluent
new global::ConsoleMonster.Interactive.AppHostKeys { CancelAction = value };    appHostKeys.CancelAction(value);

public static AppHostKeys Exit(AppHostKeys appHostKeys, KeyChord? value) #

Sets AppHostKeys.Exit: Leave the app when the focused input does not consume this key.

Parameters

appHostKeys ConsoleMonster.Interactive.AppHostKeys required: The instance.
value ConsoleMonster.Input.KeyChord? required: The value.

Returns

AppHostKeys The same instance.

Examples

// C# initializer or property                                           // C# fluent
new global::ConsoleMonster.Interactive.AppHostKeys { Exit = value };    appHostKeys.Exit(value);

public static AppHostKeys NextFocus(AppHostKeys appHostKeys, KeyChord? value) #

Sets AppHostKeys.NextFocus: Focus the next input; null lets the registry claim Tab.

Parameters

appHostKeys ConsoleMonster.Interactive.AppHostKeys required: The instance.
value ConsoleMonster.Input.KeyChord? required: The value.

Returns

AppHostKeys The same instance.

Examples

// C# initializer or property                                                // C# fluent
new global::ConsoleMonster.Interactive.AppHostKeys { NextFocus = value };    appHostKeys.NextFocus(value);

public static AppHostKeys Palette(AppHostKeys appHostKeys, KeyChord? value) #

Sets AppHostKeys.Palette: Open the action palette.

Parameters

appHostKeys ConsoleMonster.Interactive.AppHostKeys required: The instance.
value ConsoleMonster.Input.KeyChord? required: The value.

Returns

AppHostKeys The same instance.

Examples

// C# initializer or property                                              // C# fluent
new global::ConsoleMonster.Interactive.AppHostKeys { Palette = value };    appHostKeys.Palette(value);

public static AppHostKeys PreviousFocus(AppHostKeys appHostKeys, KeyChord? value) #

Sets AppHostKeys.PreviousFocus: Focus the previous input.

Parameters

appHostKeys ConsoleMonster.Interactive.AppHostKeys required: The instance.
value ConsoleMonster.Input.KeyChord? required: The value.

Returns

AppHostKeys The same instance.

Examples

// C# initializer or property                                                    // C# fluent
new global::ConsoleMonster.Interactive.AppHostKeys { PreviousFocus = value };    appHostKeys.PreviousFocus(value);