Skip to content
ConsoleMonster
Class

FormDialogOptions

ConsoleMonster.Interactive

Edit on GitHub
Namespace
ConsoleMonster.Interactive
Assembly
ConsoleMonster
Source
FormDialogOptions.cs:9
Implements
IContentOwner
Modifiers
sealed

A composed modal form definition whose result contains its named field values.

Inheritance

  • object
  • FormDialogOptions

Usage

Explore 35 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 17

Accepted by parameters 18

Constructors

public FormDialogOptions() #
FormDialogOptions.cs:9

Methods

public FormDialog<AppState> Build() #
FormDialogOptions.cs:26

Builds a typed form without starting a nested input loop.

Returns

FormDialog<AppState>

Properties

public string Title { get; set; } #
FormDialogOptions.cs:9

The visible dialog heading.

public IWidget Content { get; set; } #
FormDialogOptions.cs:11

The retained field subtree.

public string AcceptText { get; set; } #
FormDialogOptions.cs:14

The affirmative button label.

public string CancelText { get; set; } #
FormDialogOptions.cs:16

The cancellation button label.

public bool DefaultAccept { get; set; } #
FormDialogOptions.cs:18

Whether the affirmative button is initially focused. The default is Cancel.

public string? InitialFocus { get; set; } #
FormDialogOptions.cs:20

A field key to focus instead of the default button.

public int MaxWidth { get; set; } #
FormDialogOptions.cs:22

Maximum dialog width in cells.

public Func<AppState, string?>? Validate { get; set; } #
FormDialogOptions.cs:24

An app-thread validator; return an error to keep the form open.

Extension Methods

public static FormDialogOptions AcceptText(FormDialogOptions formDialogOptions, string value) #

Sets FormDialogOptions.AcceptText: The affirmative button label.

Parameters

formDialogOptions ConsoleMonster.Interactive.FormDialogOptions required
The instance.
value string required
The value.

Returns

FormDialogOptions The same instance.

Examples

// C# initializer or property                                                       // C# fluent
new global::ConsoleMonster.Interactive.FormDialogOptions { AcceptText = value };    Ui.Dialog().AcceptText(value);
public static FormDialogOptions CancelText(FormDialogOptions formDialogOptions, string value) #

Sets FormDialogOptions.CancelText: The cancellation button label.

Parameters

formDialogOptions ConsoleMonster.Interactive.FormDialogOptions required
The instance.
value string required
The value.

Returns

FormDialogOptions The same instance.

Examples

// C# initializer or property                                                       // C# fluent
new global::ConsoleMonster.Interactive.FormDialogOptions { CancelText = value };    Ui.Dialog().CancelText(value);
public static FormDialogOptions Configure(FormDialogOptions formDialogOptions, Action<FormDialogOptions> configure) #

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

Parameters

formDialogOptions ConsoleMonster.Interactive.FormDialogOptions required
The instance.
configure System.Action<ConsoleMonster.Interactive.FormDialogOptions> required
Assignments applied in order.

Returns

FormDialogOptions The same instance.

Examples

// C# initializer or property                                                     // C# fluent
new global::ConsoleMonster.Interactive.FormDialogOptions { Validate = value };    Ui.Dialog().Configure(configured => configured.Validate = value);
Content 2 overloads
public static FormDialogOptions Content(FormDialogOptions formDialogOptions, IWidget content) #

Configures this container's content before session ownership.

Parameters

formDialogOptions ConsoleMonster.Interactive.FormDialogOptions required
The instance.
content ConsoleMonster.Layout.IWidget required
The widget or nested content builder.

Returns

FormDialogOptions The same instance.
public static FormDialogOptions Content(FormDialogOptions formDialogOptions, Action<ContentBuilder> content) #

Configures this container's content before session ownership.

Parameters

formDialogOptions ConsoleMonster.Interactive.FormDialogOptions required
The instance.
content System.Action<ConsoleMonster.Layout.ContentBuilder> required
The widget or nested content builder.

Returns

FormDialogOptions The same instance.
DefaultAccept 2 overloads
public static FormDialogOptions DefaultAccept(FormDialogOptions formDialogOptions, bool value) #

Sets FormDialogOptions.DefaultAccept: Whether the affirmative button is initially focused. The default is Cancel.

Parameters

formDialogOptions ConsoleMonster.Interactive.FormDialogOptions required
The instance.
value bool required
The value.

Returns

FormDialogOptions The same instance.

Examples

// C# initializer or property                                                          // C# fluent
new global::ConsoleMonster.Interactive.FormDialogOptions { DefaultAccept = value };    Ui.Dialog().DefaultAccept(value);
public static FormDialogOptions DefaultAccept(FormDialogOptions formDialogOptions) #

Sets FormDialogOptions.DefaultAccept to true.

Parameters

formDialogOptions ConsoleMonster.Interactive.FormDialogOptions required
The instance to configure.

Returns

FormDialogOptions The same instance.
public static FormDialogOptions InitialFocus(FormDialogOptions formDialogOptions, string? value) #

Sets FormDialogOptions.InitialFocus: A field key to focus instead of the default button.

Parameters

formDialogOptions ConsoleMonster.Interactive.FormDialogOptions required
The instance.
value string? required
The value.

Returns

FormDialogOptions The same instance.

Examples

// C# initializer or property                                                         // C# fluent
new global::ConsoleMonster.Interactive.FormDialogOptions { InitialFocus = value };    Ui.Dialog().InitialFocus(value);
public static FormDialogOptions MaxWidth(FormDialogOptions formDialogOptions, int value) #

Sets FormDialogOptions.MaxWidth: Maximum dialog width in cells.

Parameters

formDialogOptions ConsoleMonster.Interactive.FormDialogOptions required
The instance.
value int required
The value.

Returns

FormDialogOptions The same instance.

Examples

// C# initializer or property                                                     // C# fluent
new global::ConsoleMonster.Interactive.FormDialogOptions { MaxWidth = value };    Ui.Dialog().MaxWidth(value);
public static FormDialogOptions Title(FormDialogOptions formDialogOptions, string value) #

Sets FormDialogOptions.Title: The visible dialog heading.

Parameters

formDialogOptions ConsoleMonster.Interactive.FormDialogOptions required
The instance.
value string required
The value.

Returns

FormDialogOptions The same instance.

Examples

// C# initializer or property                                                  // C# fluent
new global::ConsoleMonster.Interactive.FormDialogOptions { Title = value };    Ui.Dialog().Title(value);