Class SimpleProgress

Simple progress bar with and without percentage support

Inheritance

object

CyclicWriter

SimpleCyclicWriter

SimpleProgress

Namespace

Terminaux.Writer.CyclicWriters.Simple @ Terminaux.dll

Syntax

public class SimpleProgress : SimpleCyclicWriter

Constructors

SimpleProgress(int, int)

Makes a new instance of simple progress bar

Declaration

public SimpleProgress(int position, int maxPosition)

Parameters

Name	Type	Description
position	int	Current position
maxPosition	int	Max position

Properties

Accurate

Specifies whether the progress bar uses unicode block characters to accurately describe progress or not.

Remarks

If Indeterminate is true, this won't be applied.

Property Value

bool

Declaration

public bool Accurate { get; set; }

Height

Height of the vertical progress bar

Property Value

int

Declaration

public int Height { get; set; }

Indeterminate

Specifies whether the progress is indeterminate

Property Value

bool

Declaration

public bool Indeterminate { get; set; }

Position

Position of the progress bar

Property Value

int

Declaration

public int Position { get; set; }

ProgressActiveForegroundColor

Progress active foreground

Property Value

Color

Declaration

public Color ProgressActiveForegroundColor { get; set; }

ProgressBackgroundColor

Progress background

Property Value

Color

Declaration

public Color ProgressBackgroundColor { get; set; }

ProgressFailedActiveForegroundColor

Progress failed active foreground

Property Value

Color

Declaration

public Color ProgressFailedActiveForegroundColor { get; set; }

ProgressFailedForegroundColor

Progress failed foreground

Property Value

Color

Declaration

public Color ProgressFailedForegroundColor { get; set; }

ProgressForegroundColor

Progress foreground

Property Value

Color

Declaration

public Color ProgressForegroundColor { get; set; }

ProgressHorizontalActiveTrackChar

Progress horizontal active track character for drawing

Remarks

If Accurate is enabled, this property is ignored.

Property Value

char

Declaration

public char ProgressHorizontalActiveTrackChar { get; set; }

ProgressHorizontalInactiveTrackChar

Progress horizontal inactive track character for drawing

Remarks

If Accurate is enabled, this property is ignored.

Property Value

char

Declaration

public char ProgressHorizontalInactiveTrackChar { get; set; }

ProgressPausedActiveForegroundColor

Progress paused active foreground

Property Value

Color

Declaration

public Color ProgressPausedActiveForegroundColor { get; set; }

ProgressPausedForegroundColor

Progress paused foreground

Property Value

Color

Declaration

public Color ProgressPausedForegroundColor { get; set; }

ProgressPercentageTextColor

Progress percentage text color

Property Value

Color

Declaration

public Color ProgressPercentageTextColor { get; set; }

ProgressUncoloredHorizontalActiveTrackChar

Progress horizontal active track character for drawing (uncolored)

Remarks

If Accurate is enabled, this property is ignored.

Property Value

char

Declaration

public char ProgressUncoloredHorizontalActiveTrackChar { get; set; }

ProgressUncoloredHorizontalInactiveTrackChar

Progress horizontal inactive track character for drawing (uncolored)

Remarks

If Accurate is enabled, this property is ignored.

Property Value

char

Declaration

public char ProgressUncoloredHorizontalInactiveTrackChar { get; set; }

ProgressUncoloredVerticalActiveTrackChar

Progress vertical active track character for drawing (uncolored)

Remarks

If Accurate is enabled, this property is ignored.

Property Value

char

Declaration

public char ProgressUncoloredVerticalActiveTrackChar { get; set; }

ProgressUncoloredVerticalInactiveTrackChar

Progress vertical inactive track character for drawing (uncolored)

Remarks

If Accurate is enabled, this property is ignored.

Property Value

char

Declaration

public char ProgressUncoloredVerticalInactiveTrackChar { get; set; }

ProgressVerticalActiveTrackChar

Progress vertical active track character for drawing

Remarks

If Accurate is enabled, this property is ignored.

Property Value

char

Declaration

public char ProgressVerticalActiveTrackChar { get; set; }

ProgressVerticalInactiveTrackChar

Progress vertical inactive track character for drawing

Remarks

If Accurate is enabled, this property is ignored.

Property Value

char

Declaration

public char ProgressVerticalInactiveTrackChar { get; set; }

ProgressWarningActiveForegroundColor

Progress warning active foreground

Property Value

Color

Declaration

public Color ProgressWarningActiveForegroundColor { get; set; }

ProgressWarningForegroundColor

Progress warning foreground

Property Value

Color

Declaration

public Color ProgressWarningForegroundColor { get; set; }

ShowPercentage

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

Property Value

bool

Declaration

public bool ShowPercentage { get; set; }

State

State of the progress bar

Property Value

ProgressState

Declaration

public ProgressState State { get; set; }

UseColors

Whether to use colors or not

Property Value

bool

Declaration

public bool UseColors { get; set; }

Vertical

Specifies whether the progress bar is vertical or horizontal

Property Value

bool

Declaration

public bool Vertical { get; set; }

Width

Width of the progress bar

Property Value

int

Declaration

public int Width { get; set; }

Methods

Render()

Renders a scrolling text progress bar

Returns

string

The result

Declaration

public override string Render()

Overrides

CyclicWriter.Render()