Class SimpleProgress

Simple progress bar with and without percentage support

Inheritance
object
SimpleProgress
Implements
Namespace: Terminaux.Writer.CyclicWriters
Assembly: Terminaux.dll
Syntax
public class SimpleProgress : IStaticRenderable

Constructors

| Edit this page View Source

SimpleProgress(int, int)

Makes a new instance of simple progress bar

Declaration
public SimpleProgress(int position, int maxPosition)
Parameters
Type Name Description
int position

Current position
int maxPosition

Max position

Properties

| Edit this page View Source

Height

Height of the vertical progress bar

Declaration
public int Height { get; set; }
Property Value
Type Description
int
| Edit this page View Source

Indeterminate

Specifies whether the progress is indeterminate

Declaration
public bool Indeterminate { get; set; }
Property Value
Type Description
bool
| Edit this page View Source

LeftMargin

Left margin of the progress bar

Declaration
public int LeftMargin { get; set; }
Property Value
Type Description
int
| Edit this page View Source

Position

Position of the progress bar

Declaration
public int Position { get; set; }
Property Value
Type Description
int
| Edit this page View Source

ProgressActiveForegroundColor

Progress active foreground

Declaration
public Color ProgressActiveForegroundColor { get; set; }
Property Value
Type Description
Color
| Edit this page View Source

ProgressBackgroundColor

Progress background

Declaration
public Color ProgressBackgroundColor { get; set; }
Property Value
Type Description
Color
| Edit this page View Source

ProgressForegroundColor

Progress foreground

Declaration
public Color ProgressForegroundColor { get; set; }
Property Value
Type Description
Color
| Edit this page View Source

ProgressHorizontalActiveTrackChar

Progress horizontal active track character for drawing

Declaration
public char ProgressHorizontalActiveTrackChar { get; set; }
Property Value
Type Description
char
| Edit this page View Source

ProgressHorizontalInactiveTrackChar

Progress horizontal inactive track character for drawing

Declaration
public char ProgressHorizontalInactiveTrackChar { get; set; }
Property Value
Type Description
char
| Edit this page View Source

ProgressPercentageTextColor

Progress percentage text color

Declaration
public Color ProgressPercentageTextColor { get; set; }
Property Value
Type Description
Color
| Edit this page View Source

ProgressVerticalActiveTrackChar

Progress vertical active track character for drawing

Declaration
public char ProgressVerticalActiveTrackChar { get; set; }
Property Value
Type Description
char
| Edit this page View Source

ProgressVerticalInactiveTrackChar

Progress vertical inactive track character for drawing

Declaration
public char ProgressVerticalInactiveTrackChar { get; set; }
Property Value
Type Description
char
| Edit this page View Source

RightMargin

Right margin of the progress bar

Declaration
public int RightMargin { get; set; }
Property Value
Type Description
int
| Edit this page View Source

ShowPercentage

Specifies whether the progress bar shows percentage or not (ignored in indeterminate progress bars)

Declaration
public bool ShowPercentage { get; set; }
Property Value
Type Description
bool
| Edit this page View Source

UseColors

Whether to use colors or not

Declaration
public bool UseColors { get; set; }
Property Value
Type Description
bool
| Edit this page View Source

Vertical

Specifies whether the progress bar is vertical or horizontal

Declaration
public bool Vertical { get; set; }
Property Value
Type Description
bool

Methods

| Edit this page View Source

Render()

Renders a scrolling text progress bar

Declaration
public string Render()
Returns
Type Description
string

The result

Implements