Skip to content
ConsoleMonster
Class

ButtonInputOptions

ConsoleMonster.Interactive

Edit on GitHub
Namespace
ConsoleMonster.Interactive
Assembly
ConsoleMonster
Source
ButtonInputOptions.cs:7
Base
AppInputOptions
Modifiers
sealed

Constructs an action button with the same callback names as New-ConsoleButton.

Inheritance

Usage

Explore 36 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 15

Accepted by parameters 21

Constructors

public ButtonInputOptions() #

Properties

public AppCommand? Command { get; set; } #
ButtonInputOptions.cs:7

An in-app command shared with shortcuts and the palette. Mutually exclusive with OnClick.

public EventHandler? OnClick { get; set; } #
ButtonInputOptions.cs:9

Runs once per activation, after releasing the control's state lock.

Extension Methods

public static Button Build(ButtonInputOptions options) #
Ui.Construction.cs:26

Creates a button through the shared input factory.

Parameters

options ConsoleMonster.Interactive.ButtonInputOptions required
The configured definition.

Returns

Button The button.
Command 2 overloads
public static ButtonInputOptions Command(ButtonInputOptions buttonInputOptions, AppCommand? value) #

Sets ButtonInputOptions.Command: An in-app command shared with shortcuts and the palette. Mutually exclusive with OnClick.

Parameters

buttonInputOptions ConsoleMonster.Interactive.ButtonInputOptions required
The instance.
value ConsoleMonster.Interactive.AppCommand? required
The value.

Returns

ButtonInputOptions The same instance.

Examples

// C# initializer or property                                                     // C# fluent
new global::ConsoleMonster.Interactive.ButtonInputOptions { Command = value };    Ui.Button().Command(value);
public static ButtonInputOptions Command(ButtonInputOptions buttonInputOptions, Action<AppCommand> configure) #

Configures ButtonInputOptions.Command in place: An in-app command shared with shortcuts and the palette. Mutually exclusive with OnClick.

Parameters

buttonInputOptions ConsoleMonster.Interactive.ButtonInputOptions required
The instance.
configure System.Action<ConsoleMonster.Interactive.AppCommand> required
Configures the value.

Returns

ButtonInputOptions The same instance.
public static ButtonInputOptions Configure(ButtonInputOptions buttonInputOptions, Action<ButtonInputOptions> configure) #

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

Parameters

buttonInputOptions ConsoleMonster.Interactive.ButtonInputOptions required
The instance.
configure System.Action<ConsoleMonster.Interactive.ButtonInputOptions> required
Assignments applied in order.

Returns

ButtonInputOptions The same instance.

Examples

// C# initializer or property                                                     // C# fluent
new global::ConsoleMonster.Interactive.ButtonInputOptions { OnClick = value };    Ui.Button().Configure(configured => configured.OnClick = value);
// C# initializer or property                                                      // C# fluent
new global::ConsoleMonster.Interactive.ButtonInputOptions { OnChange = value };    Ui.Button().Configure(configured => configured.OnChange = value);
Disabled 2 overloads
public static ButtonInputOptions Disabled(ButtonInputOptions buttonInputOptions, bool value) #

Sets AppInputOptions.Disabled: Disables editing and keyboard focus.

Parameters

buttonInputOptions ConsoleMonster.Interactive.ButtonInputOptions required
The instance.
value bool required
The value.

Returns

ButtonInputOptions The same instance.

Examples

// C# initializer or property                                                      // C# fluent
new global::ConsoleMonster.Interactive.ButtonInputOptions { Disabled = value };    Ui.Button().Disabled(value);
public static ButtonInputOptions Disabled(ButtonInputOptions buttonInputOptions) #

Sets AppInputOptions.Disabled to true.

Parameters

buttonInputOptions ConsoleMonster.Interactive.ButtonInputOptions required
The instance to configure.

Returns

ButtonInputOptions The same instance.
public static ButtonInputOptions Key(ButtonInputOptions buttonInputOptions, string value) #

Sets AppInputOptions.Key: The unique application-state key.

Parameters

buttonInputOptions ConsoleMonster.Interactive.ButtonInputOptions required
The instance.
value string required
The value.

Returns

ButtonInputOptions The same instance.

Examples

// C# initializer or property                                                 // C# fluent
new global::ConsoleMonster.Interactive.ButtonInputOptions { Key = value };    Ui.Button().Key(value);
public static ButtonInputOptions Label(ButtonInputOptions buttonInputOptions, string? value) #

Sets AppInputOptions.Label: The visible label; null uses the key.

Parameters

buttonInputOptions ConsoleMonster.Interactive.ButtonInputOptions required
The instance.
value string? required
The value.

Returns

ButtonInputOptions The same instance.

Examples

// C# initializer or property                                                   // C# fluent
new global::ConsoleMonster.Interactive.ButtonInputOptions { Label = value };    Ui.Button().Label(value);
public static ButtonInputOptions TabIndex(ButtonInputOptions buttonInputOptions, int value) #

Sets AppInputOptions.TabIndex: Keyboard focus order; equal values preserve declaration order.

Parameters

buttonInputOptions ConsoleMonster.Interactive.ButtonInputOptions required
The instance.
value int required
The value.

Returns

ButtonInputOptions The same instance.

Examples

// C# initializer or property                                                      // C# fluent
new global::ConsoleMonster.Interactive.ButtonInputOptions { TabIndex = value };    Ui.Button().TabIndex(value);
public static ButtonInputOptions ValidationMessage(ButtonInputOptions buttonInputOptions, string? value) #

Sets AppInputOptions.ValidationMessage: Initial validation text.

Parameters

buttonInputOptions ConsoleMonster.Interactive.ButtonInputOptions required
The instance.
value string? required
The value.

Returns

ButtonInputOptions The same instance.

Examples

// C# initializer or property                                                               // C# fluent
new global::ConsoleMonster.Interactive.ButtonInputOptions { ValidationMessage = value };    Ui.Button().ValidationMessage(value);