API Reference
Class
ProgressHandle
Thread-safe live handle for a ProgressBar.
Inheritance
- LiveHandle
- ProgressHandle
Usage
Explore 1 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 1
- Method ProgressBar.Handle
Constructors
public ProgressHandle(ILiveDispatcher dispatcher, String target) #Creates a handle.
Parameters
- dispatcher ConsoleMonster.Live.ILiveDispatcher
- The dispatcher.
- target System.String
- The bar name.
Methods
public Void Advance(Double amount = 1) #Returns:
VoidAdds to the value.
Parameters
- amount System.Double = 1
- The amount (default 1).
public Void Complete(StatusKind status = Pass) #Returns:
VoidSets the final status (Pass, Fail, Warn).
Parameters
- status ConsoleMonster.Styling.StatusKind = Pass
- The status.
public Void Label(String label) #Returns:
VoidChanges the label.
Parameters
- label System.String
- The label (markup).
public Void Set(Double value, Double total = 0) #Returns:
VoidSets the value (and optionally the total).
Parameters
- value System.Double
- The value.
- total System.Double = 0
- The total, or 0 to keep it.
Inherited Methods
public virtual Boolean Equals(Object? obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object?