MenuRunResult
ConsoleMonster.Interactive
The outcome of a run, shown by the menu afterwards: a status, a summary, key figures, details and next actions.
Inheritance
- object
- MenuRunResult
Usage
Explore 6 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 4
- Property FormResult.RunResult
- Method MenuContext.Run
- Method MenuRunResult.Figure
- Method MenuRunResult.Next
Accepted by parameters 2
- Method MenuContext.Run
- Method MenuContext.ShowResult
Constructors
public MenuRunResult(string title, StatusKind status = Pass) #Creates a result.
Parameters
- title string
- The title ("Checks finished").
- status ConsoleMonster.Styling.StatusKind = Pass
- The status.
Methods
public MenuRunResult Figure(string label, string value) #Adds a key figure.
Parameters
- label string
- The label.
- value string
- The value.
public MenuRunResult Figure(string label, string value, StatusKind status) #Adds a key figure whose number carries a status colour (use it only for figures that need attention).
Parameters
- label string
- The label.
- value string
- The value.
- status ConsoleMonster.Styling.StatusKind
- The status.
Inherited Methods
Properties
public IList<KeyValuePair<string, string>> Figures { get; } #Key figures shown as label/value pairs ("Passed" = "41").
public IDictionary<string, StatusKind> FigureStatus { get; } #The status of each figure that has one (its number is coloured), by label.
public IWidget? Details { get; set; } #Detail content under the figures (a table, a list).
public IList<MenuItem> NextActions { get; } #Actions offered next ("Open report", "Run failed again", "Export").
public TimeSpan Elapsed { get; set; } #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.