MenuRunResultFluent
ConsoleMonster.Interactive
- Namespace
ConsoleMonster.Interactive- Assembly
ConsoleMonster- Modifiers
- static
- Attributes
GeneratedCode("ConsoleMonster.Generators", "1.0.0")
The fluent methods of MenuRunResult, generated from its public properties: A property-named method sets a property and Add... adds to a collection, both returning the same instance.
Inheritance
- object
- MenuRunResultFluent
Methods
public static MenuRunResult AddFigure(MenuRunResult menuRunResult, KeyValuePair<string, string> item) #Adds an item to MenuRunResult.Figures: Key figures shown as label/value pairs ("Passed" = "41").
Parameters
- menuRunResult ConsoleMonster.Interactive.MenuRunResult required
- The instance.
- item System.Collections.Generic.KeyValuePair<string, string> required
- The item.
public static MenuRunResult AddFigures(MenuRunResult menuRunResult, params KeyValuePair<string, string>[] items) #Adds items to MenuRunResult.Figures: Key figures shown as label/value pairs ("Passed" = "41").
Parameters
- menuRunResult ConsoleMonster.Interactive.MenuRunResult required
- The instance.
- items System.Collections.Generic.KeyValuePair<string, string>[] required
- The items, in order.
public static MenuRunResult AddFigures(MenuRunResult menuRunResult, IEnumerable<KeyValuePair<string, string>> items) #Adds items to MenuRunResult.Figures: Key figures shown as label/value pairs ("Passed" = "41").
Parameters
- menuRunResult ConsoleMonster.Interactive.MenuRunResult required
- The instance.
- items System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<string, string>> required
- The items, in order.
public static MenuRunResult AddNextAction(MenuRunResult menuRunResult, MenuItem item) #Adds an item to MenuRunResult.NextActions: Actions offered next ("Open report", "Run failed again", "Export").
Parameters
- menuRunResult ConsoleMonster.Interactive.MenuRunResult required
- The instance.
- item ConsoleMonster.Interactive.MenuItem required
- The item.
public static MenuRunResult AddNextActions(MenuRunResult menuRunResult, params MenuItem[] items) #Adds items to MenuRunResult.NextActions: Actions offered next ("Open report", "Run failed again", "Export").
Parameters
- menuRunResult ConsoleMonster.Interactive.MenuRunResult required
- The instance.
- items ConsoleMonster.Interactive.MenuItem[] required
- The items, in order.
public static MenuRunResult AddNextActions(MenuRunResult menuRunResult, IEnumerable<MenuItem> items) #Adds items to MenuRunResult.NextActions: Actions offered next ("Open report", "Run failed again", "Export").
Parameters
- menuRunResult ConsoleMonster.Interactive.MenuRunResult required
- The instance.
- items System.Collections.Generic.IEnumerable<ConsoleMonster.Interactive.MenuItem> required
- The items, in order.
public static MenuRunResult Details(MenuRunResult menuRunResult, IWidget? value) #Sets MenuRunResult.Details: Detail content under the figures (a table, a list).
Parameters
- menuRunResult ConsoleMonster.Interactive.MenuRunResult required
- The instance.
- value ConsoleMonster.Layout.IWidget? required
- The value.
Examples
// C# initializer or property // C# fluent
menuRunResult.Details = value; Ui.MenuRunResult().Details(value);public static MenuRunResult Elapsed(MenuRunResult menuRunResult, TimeSpan value) #Sets MenuRunResult.Elapsed: How long the run took; left at zero, a run started with MenuContext.Run fills it in from the session clock (LiveSessionOptions.Clock), so a SimulatedClock gives its time.
Parameters
- menuRunResult ConsoleMonster.Interactive.MenuRunResult required
- The instance.
- value System.TimeSpan required
- The value.
Examples
// C# initializer or property // C# fluent
menuRunResult.Elapsed = value; Ui.MenuRunResult().Elapsed(value);public static MenuRunResult Error(MenuRunResult menuRunResult, Exception? value) #Sets MenuRunResult.Error: The exception that ended the run, if any.
Parameters
- menuRunResult ConsoleMonster.Interactive.MenuRunResult required
- The instance.
- value System.Exception? required
- The value.
Examples
// C# initializer or property // C# fluent
menuRunResult.Error = value; Ui.MenuRunResult().Error(value);public static MenuRunResult Status(MenuRunResult menuRunResult, StatusKind value) #Sets MenuRunResult.Status: The status.
Parameters
- menuRunResult ConsoleMonster.Interactive.MenuRunResult required
- The instance.
- value ConsoleMonster.Styling.StatusKind required
- The value.
Examples
// C# initializer or property // C# fluent
menuRunResult.Status = value; Ui.MenuRunResult().Status(value);public static MenuRunResult Summary(MenuRunResult menuRunResult, string? value) #Sets MenuRunResult.Summary: A sentence under the title.
Parameters
- menuRunResult ConsoleMonster.Interactive.MenuRunResult required
- The instance.
- value string? required
- The value.
Examples
// C# initializer or property // C# fluent
menuRunResult.Summary = value; Ui.MenuRunResult().Summary(value);public static MenuRunResult Title(MenuRunResult menuRunResult, string value) #Sets MenuRunResult.Title: The title.
Parameters
- menuRunResult ConsoleMonster.Interactive.MenuRunResult required
- The instance.
- value string required
- The value.
Examples
// C# initializer or property // C# fluent
menuRunResult.Title = value; Ui.MenuRunResult().Title(value);