Class

MenuItemFluent

ConsoleMonster.Interactive

Edit on GitHub

Namespace: ConsoleMonster.Interactive
Assembly: ConsoleMonster
Source: MenuItem.Fluent.cs:11
Modifiers: static
Attributes: GeneratedCode("ConsoleMonster.Generators", "1.0.0")

Invariant-preserving overloads alongside generated menu-item property methods.

Inheritance

object
MenuItemFluent

Methods

public static MenuItem AddChoice(MenuItem menuItem, Choice item) #

Adds an item to MenuItem.Choices: The choices of a selection item.

Parameters

menuItem ConsoleMonster.Interactive.MenuItem required: The instance.
item ConsoleMonster.Interactive.Choice required: The item.

Returns

MenuItem The same instance.

AddChoices 2 overloads

public static MenuItem AddChoices(MenuItem menuItem, params Choice[] items) #

Adds items to MenuItem.Choices: The choices of a selection item.

Parameters

menuItem ConsoleMonster.Interactive.MenuItem required: The instance.
items ConsoleMonster.Interactive.Choice[] required: The items, in order.

Returns

MenuItem The same instance.

public static MenuItem AddChoices(MenuItem menuItem, IEnumerable<Choice> items) #

Adds items to MenuItem.Choices: The choices of a selection item.

Parameters

menuItem ConsoleMonster.Interactive.MenuItem required: The instance.
items System.Collections.Generic.IEnumerable<ConsoleMonster.Interactive.Choice> required: The items, in order.

Returns

MenuItem The same instance.

public static MenuItem Configure(MenuItem menuItem, Action<MenuItem> configure) #

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

Parameters

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

Returns

MenuItem The same instance.

Examples

// C# initializer or property    // C# fluent
menuItem.Badge = value;          Ui.MenuItem().Configure(configured => configured.Badge = value);

// C# initializer or property    // C# fluent
menuItem.Detail = value;         Ui.MenuItem().Configure(configured => configured.Detail = value);

// C# initializer or property       // C# fluent
menuItem.DisabledReason = value;    Ui.MenuItem().Configure(configured => configured.DisabledReason = value);

// C# initializer or property    // C# fluent
menuItem.Action = value;         Ui.MenuItem().Configure(configured => configured.Action = value);

// C# initializer or property    // C# fluent
menuItem.ActionAsync = value;    Ui.MenuItem().Configure(configured => configured.ActionAsync = value);

// C# initializer or property    // C# fluent
menuItem.OnSubmit = value;       Ui.MenuItem().Configure(configured => configured.OnSubmit = value);

// C# initializer or property    // C# fluent
menuItem.Page = value;           Ui.MenuItem().Configure(configured => configured.Page = value);

// C# initializer or property    // C# fluent
menuItem.Preview = value;        Ui.MenuItem().Configure(configured => configured.Preview = value);

// C# initializer or property    // C# fluent
menuItem.LoadChoices = value;    Ui.MenuItem().Configure(configured => configured.LoadChoices = value);

// C# initializer or property    // C# fluent
menuItem.Review = value;         Ui.MenuItem().Configure(configured => configured.Review = value);

// C# initializer or property    // C# fluent
menuItem.OnChange = value;       Ui.MenuItem().Configure(configured => configured.OnChange = value);

public static MenuItem CurrentBadge(MenuItem menuItem, Action<RichText> configure) #

Configures MenuItem.CurrentBadge in place: The badge now.

Parameters

menuItem ConsoleMonster.Interactive.MenuItem required: The instance.
configure System.Action<ConsoleMonster.Text.RichText> required: Configures the value.

Returns

MenuItem The same instance.

public static MenuItem Description(MenuItem menuItem, string? value) #

Sets MenuItem.Description: A sentence shown with the item.

Parameters

menuItem ConsoleMonster.Interactive.MenuItem required: The instance.
value string? required: The value.

Returns

MenuItem The same instance.

Examples

// C# initializer or property    // C# fluent
menuItem.Description = value;    Ui.MenuItem().Description(value);

Form 3 overloads

public static MenuItem Form(MenuItem item, Form form, Action<MenuContext, FormResult>? submitted = null) #

MenuItem.Fluent.cs:22

Makes the item open a form.

Parameters

item ConsoleMonster.Interactive.MenuItem required: The menu item.
form ConsoleMonster.Interactive.Form required: The form.
submitted System.Action<ConsoleMonster.Interactive.MenuContext, ConsoleMonster.Interactive.FormResult>? = null optional: Called when it is submitted.

Returns

MenuItem The item.

public static MenuItem Form(MenuItem menuItem, Form? value) #

Sets MenuItem.Form: The form of a form item.

Parameters

menuItem ConsoleMonster.Interactive.MenuItem required: The instance.
value ConsoleMonster.Interactive.Form? required: The value.

Returns

MenuItem The same instance.

Examples

// C# initializer or property    // C# fluent
menuItem.Form = value;           Ui.MenuItem().Form(value);

public static MenuItem Form(MenuItem menuItem, Action<Form> configure) #

Configures MenuItem.Form in place: The form of a form item.

Parameters

menuItem ConsoleMonster.Interactive.MenuItem required: The instance.
configure System.Action<ConsoleMonster.Interactive.Form> required: Configures the value.

Returns

MenuItem The same instance.

public static MenuItem Hotkey(MenuItem menuItem, char? value) #

Sets MenuItem.Hotkey: The key that opens the item directly.

Parameters

menuItem ConsoleMonster.Interactive.MenuItem required: The instance.
value char? required: The value.

Returns

MenuItem The same instance.

Examples

// C# initializer or property    // C# fluent
menuItem.Hotkey = value;         Ui.MenuItem().Hotkey(value);

public static MenuItem Icon(MenuItem menuItem, string? value) #

Sets MenuItem.Icon: A short mark before the title (one or two cells), as free text. Setting it clears a preceding semantic IconName.

Parameters

menuItem ConsoleMonster.Interactive.MenuItem required: The instance.
value string? required: The value.

Returns

MenuItem The same instance.

Examples

// C# initializer or property    // C# fluent
menuItem.Icon = value;           Ui.MenuItem().Icon(value);

public static MenuItem IconName(MenuItem menuItem, GlyphIcon? value) #

Sets MenuItem.IconName: A semantic icon resolved for the glyph tier (shapes in Full, WGL4 in Basic, ASCII in Ascii), or null.

Parameters

menuItem ConsoleMonster.Interactive.MenuItem required: The instance.
value ConsoleMonster.Glyphs.GlyphIcon? required: The value.

Returns

MenuItem The same instance.

Examples

// C# initializer or property    // C# fluent
menuItem.IconName = value;       Ui.MenuItem().IconName(value);

public static MenuItem Kind(MenuItem menuItem, MenuItemKind value) #

Sets MenuItem.Kind: What the item does.

Parameters

menuItem ConsoleMonster.Interactive.MenuItem required: The instance.
value ConsoleMonster.Interactive.MenuItemKind required: The value.

Returns

MenuItem The same instance.

Examples

// C# initializer or property    // C# fluent
menuItem.Kind = value;           Ui.MenuItem().Kind(value);

public static MenuItem Label(MenuItem menuItem, string value) #

Sets MenuItem.Label: The title.

Parameters

menuItem ConsoleMonster.Interactive.MenuItem required: The instance.
value string required: The value.

Returns

MenuItem The same instance.

Examples

// C# initializer or property    // C# fluent
menuItem.Label = value;          Ui.MenuItem().Label(value);

public static MenuItem Maximum(MenuItem menuItem, int? value) #

Sets MenuItem.Maximum: The most values of a multi-selection item.

Parameters

menuItem ConsoleMonster.Interactive.MenuItem required: The instance.
value int? required: The value.

Returns

MenuItem The same instance.

Examples

// C# initializer or property    // C# fluent
menuItem.Maximum = value;        Ui.MenuItem().Maximum(value);

public static MenuItem Minimum(MenuItem menuItem, int? value) #

Sets MenuItem.Minimum: The fewest values of a multi-selection item.

Parameters

menuItem ConsoleMonster.Interactive.MenuItem required: The instance.
value int? required: The value.

Returns

MenuItem The same instance.

Examples

// C# initializer or property    // C# fluent
menuItem.Minimum = value;        Ui.MenuItem().Minimum(value);

Submenu 2 overloads

public static MenuItem Submenu(MenuItem menuItem, Menu? value) #

Sets MenuItem.Submenu: The submenu of a submenu item.

Parameters

menuItem ConsoleMonster.Interactive.MenuItem required: The instance.
value ConsoleMonster.Interactive.Menu? required: The value.

Returns

MenuItem The same instance.

Examples

// C# initializer or property    // C# fluent
menuItem.Submenu = value;        Ui.MenuItem().Submenu(value);

Inheritance

Methods

Inherited Methods