API Reference
StatusContext
The running status of Terminal.Status: change its text with StatusContext.Update. On an interactive VT terminal it is a transient inline live area with a Spinner: console output and Terminal writes made meanwhile scroll above it, and the line is removed when the work ends. In redirected output, CI logs and plain mode each new text is printed once as a plain line (no spinner, no redraw), as Write-ConsoleStatus does. Updates are thread-safe.
Inheritance
- Object
- StatusContext
Usage
Explore 8 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 8
- Extension method ITerminalTarget.Status
- Extension method ITerminalTarget.StatusAsync
- Method TerminalTargetExtensions.Status
- Method TerminalTargetExtensions.StatusAsync
- Method Terminal.Status
- Method Terminal.StatusAsync
- Method Terminal.StatusAsync``1
- Method Terminal.Status``1
Methods
public Void Dispose() #VoidEnds the status: the live line is removed (output written meanwhile stays).
public Void Update(String markup) #VoidChanges the status text.
Parameters
- markup System.String
- The new text, as markup ([muted]3 of 10[/]); escape values with Markup.Escape.
public Void Update(RichText text) #VoidChanges the status text.
Parameters
- text ConsoleMonster.Text.RichText
- The new text.
Inherited Methods
public virtual Boolean Equals(Object? obj) #BooleanParameters
- obj Object?
Properties
public Boolean IsLive { get; } #Whether the status is drawn in place with a spinner (false: printed as plain lines).