Skip to content
ConsoleMonster

API Reference

Interface

ITaskbarProgressSource

Namespace ConsoleMonster.Output
Assembly ConsoleMonster
Modifiers abstract

A widget that contributes to the terminal's progress indicator while it is in a live session: progress bars and lanes report a percentage, spinners and activities report work in progress, a dashboard reports failures and warnings. Implement it on custom widgets to take part.

Methods

public abstract Boolean TryGetTaskbarProgress(out TaskbarState state, out Double fraction) #
Returns: Boolean

The widget's contribution, if any.

Parameters

state ConsoleMonster.Output.TaskbarState requiredposition: 0
The state (Normal, Indeterminate, Error or Paused).
fraction System.Double requiredposition: 1
The fraction done (0 to 1), or NaN when unknown.

Returns

False when the widget has nothing to report.