Class AnsiCliProgressContext
Container for one or more ANSI console progress bars.
Namespace: NanoByte.Common.Tasks
Assembly: NanoByte.Common.AnsiCli.dll
Syntax
public sealed class AnsiCliProgressContext : Object
Constructors
AnsiCliProgressContext()
Starts a progress context.
Declaration
public AnsiCliProgressContext()
Properties
IsFinished
Indicates whether all tasks have completed.
Declaration
public bool IsFinished { get; }
Property Value
Type | Description |
---|---|
Boolean |
Methods
Add(String)
Adds a new progress bar to the context.
Declaration
public IProgress<TaskSnapshot> Add(string description)
Parameters
Type | Name | Description |
---|---|---|
String | description | A descriptive text to show next to the progress bar. |
Returns
Type | Description |
---|---|
IProgress<TaskSnapshot> | A handle for updating the state of the progress bar. |
Dispose()
Ends the progress context.
Declaration
public void Dispose()