NanoByte.Common  2.7.5
NanoByte.Common.Tasks.AnsiCliProgressContext Class Reference

Container for one or more ANSI console progress bars. More...

Inheritance diagram for NanoByte.Common.Tasks.AnsiCliProgressContext:

Public Member Functions

 AnsiCliProgressContext ()
 Starts a progress context. More...
 
void Dispose ()
 Ends the progress context. More...
 
IProgress< TaskSnapshotAdd (string description)
 Adds a new progress bar to the context. More...
 

Properties

bool IsFinished [get]
 Indicates whether all tasks have completed. More...
 

Detailed Description

Container for one or more ANSI console progress bars.

Constructor & Destructor Documentation

◆ AnsiCliProgressContext()

NanoByte.Common.Tasks.AnsiCliProgressContext.AnsiCliProgressContext ( )

Starts a progress context.

Member Function Documentation

◆ Add()

IProgress<TaskSnapshot> NanoByte.Common.Tasks.AnsiCliProgressContext.Add ( string  description)

Adds a new progress bar to the context.

Parameters
descriptionA descriptive text to show next to the progress bar.
Returns
A handle for updating the state of the progress bar.

◆ Dispose()

void NanoByte.Common.Tasks.AnsiCliProgressContext.Dispose ( )

Ends the progress context.

Property Documentation

◆ IsFinished

bool NanoByte.Common.Tasks.AnsiCliProgressContext.IsFinished
get

Indicates whether all tasks have completed.


The documentation for this class was generated from the following file: