API Reference
Class
RunResult
The outcome of a run, shown by the menu afterwards: a status, a summary, key figures, details and next actions.
Inheritance
- Object
- RunResult
Usage
Explore 2 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.
Accepted by parameters 2
- Method MenuContext.Run
- Method MenuContext.ShowResult
Constructors
public RunResult(String title, StatusKind status = Pass) #Creates a result.
Parameters
- title System.String
- The title ("Checks finished").
- status ConsoleMonster.Styling.StatusKind = Pass
- The status.
Methods
Figure 2 overloads
public RunResult Figure(String label, String value) #Returns:
RunResultAdds a key figure.
Parameters
- label System.String
- The label.
- value System.String
- The value.
Returns
The result.
public RunResult Figure(String label, String value, StatusKind status) #Returns:
RunResultAdds a key figure whose number carries a status colour (use it only for figures that need attention).
Parameters
- label System.String
- The label.
- value System.String
- The value.
- status ConsoleMonster.Styling.StatusKind
- The status.
Returns
The result.
Inherited Methods
public virtual Boolean Equals(Object? obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object?
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").