Class ProgressBar

Progress bar with text

Inheritance

object

CyclicWriter

SimpleCyclicWriter

ProgressBar

Namespace: Terminaux.Writer.CyclicWriters.Simple

Assembly: Terminaux.dll

Syntax

public class ProgressBar : SimpleCyclicWriter

Constructors

| Edit this page View Source

ProgressBar(Mark, int, int, Spinner?, TextMarquee?, params object?[]?)

Makes a new instance of progress bar

Declaration

public ProgressBar(Mark text, int position, int maxPosition, Spinner? progressSpinner = null, TextMarquee? progressMarquee = null, params object?[]? args)

Parameters

Type	Name	Description
Mark	text	Text to render. All VT sequences and control characters are trimmed away.
int	position	Current position
int	maxPosition	Max position
Spinner	progressSpinner	Spinner instance to use, or SpinMore
TextMarquee	progressMarquee	Marquee writer to use
object[]	args	Arguments to format the string with

Properties

| Edit this page View Source

Accurate

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

Declaration

public bool Accurate { get; set; }

Property Value

Type	Description
bool

Remarks

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

| Edit this page View Source

Delay

Delay interval for marquee. The default is 30 ticks for 100 milliseconds, but you can adjust it, depending on the speed of the loop.

Declaration

public int Delay { 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

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

ProgressFailedActiveForegroundColor

Progress failed active foreground

Declaration

public Color ProgressFailedActiveForegroundColor { get; set; }

Property Value

Type	Description
Color

| Edit this page View Source

ProgressFailedForegroundColor

Progress failed foreground

Declaration

public Color ProgressFailedForegroundColor { 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

Remarks

If Accurate is enabled, this property is ignored.

| Edit this page View Source

ProgressHorizontalInactiveTrackChar

Progress horizontal inactive track character for drawing

Declaration

public char ProgressHorizontalInactiveTrackChar { get; set; }

Property Value

Type	Description
char

Remarks

If Accurate is enabled, this property is ignored.

| Edit this page View Source

ProgressPausedActiveForegroundColor

Progress paused active foreground

Declaration

public Color ProgressPausedActiveForegroundColor { get; set; }

Property Value

Type	Description
Color

| Edit this page View Source

ProgressPausedForegroundColor

Progress paused foreground

Declaration

public Color ProgressPausedForegroundColor { get; set; }

Property Value

Type	Description
Color

| 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

ProgressSpinnerTextColor

Progress spinner color

Declaration

public Color ProgressSpinnerTextColor { get; set; }

Property Value

Type	Description
Color

| Edit this page View Source

ProgressTextColor

Progress text color

Declaration

public Color ProgressTextColor { get; set; }

Property Value

Type	Description
Color

| Edit this page View Source

ProgressUncoloredHorizontalActiveTrackChar

Progress horizontal active track character for drawing (uncolored)

Declaration

public char ProgressUncoloredHorizontalActiveTrackChar { get; set; }

Property Value

Type	Description
char

Remarks

If Accurate is enabled, this property is ignored.

| Edit this page View Source

ProgressUncoloredHorizontalInactiveTrackChar

Progress horizontal inactive track character for drawing (uncolored)

Declaration

public char ProgressUncoloredHorizontalInactiveTrackChar { get; set; }

Property Value

Type	Description
char

Remarks

If Accurate is enabled, this property is ignored.

| Edit this page View Source

ProgressUncoloredVerticalActiveTrackChar

Progress vertical active track character for drawing (uncolored)

Declaration

public char ProgressUncoloredVerticalActiveTrackChar { get; set; }

Property Value

Type	Description
char

Remarks

If Accurate is enabled, this property is ignored.

| Edit this page View Source

ProgressUncoloredVerticalInactiveTrackChar

Progress vertical inactive track character for drawing (uncolored)

Declaration

public char ProgressUncoloredVerticalInactiveTrackChar { get; set; }

Property Value

Type	Description
char

Remarks

If Accurate is enabled, this property is ignored.

| Edit this page View Source

ProgressVerticalActiveTrackChar

Progress vertical active track character for drawing

Declaration

public char ProgressVerticalActiveTrackChar { get; set; }

Property Value

Type	Description
char

Remarks

If Accurate is enabled, this property is ignored.

| Edit this page View Source

ProgressVerticalInactiveTrackChar

Progress vertical inactive track character for drawing

Declaration

public char ProgressVerticalInactiveTrackChar { get; set; }

Property Value

Type	Description
char

Remarks

If Accurate is enabled, this property is ignored.

| Edit this page View Source

ProgressWarningActiveForegroundColor

Progress warning active foreground

Declaration

public Color ProgressWarningActiveForegroundColor { get; set; }

Property Value

Type	Description
Color

| Edit this page View Source

ProgressWarningForegroundColor

Progress warning foreground

Declaration

public Color ProgressWarningForegroundColor { get; set; }

Property Value

Type	Description
Color

| 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

State

State of the progress bar

Declaration

public ProgressState State { get; set; }

Property Value

Type	Description
ProgressState

| Edit this page View Source

Text

Text to render. All VT sequences and control characters are trimmed away.

Declaration

public string Text { get; }

Property Value

Type	Description
string

| 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

Width

Width of the progress bar

Declaration

public int Width { get; set; }

Property Value

Type	Description
int

Methods

| Edit this page View Source

Render()

Renders a scrolling text progress bar

Declaration

public override string Render()

Returns

Type	Description
string	The result

Overrides

CyclicWriter.Render()