Class FakeLoadingBar

Namespace

ConsoleAppVisuals.AnimatedElements

Assembly

ConsoleAppVisuals.dll

The FakeLoadingBar is an animated element that simulates a loading bar with a fixed duration.

public class FakeLoadingBar : AnimatedElement

Inheritance

object

Element

AnimatedElement

FakeLoadingBar

Inherited Members

AnimatedElement.RenderOptionsAfterHand()

AnimatedElement.Type

AnimatedElement.MaxNumberOfThisElement

Element.ToggleVisibility()

Element.RenderElement()

Element.RenderOptionsBeforeHand()

Element.RenderElementSpace(bool)

Element.GetRenderSpace()

Element.Clear()

Element.Id

Element.Visibility

Element.TextAlignment

Element.Line

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Remarks

For more information, consider visiting the documentation available here.

Constructors

FakeLoadingBar(string, int, Placement, int, int, BordersType)

The FakeLoadingBar is an animated element that simulates a loading bar with a fixed duration.

public FakeLoadingBar(string text = "Loading ...", int barWidth = 0, Placement placement = Placement.TopCenter, int processDuration = 2000, int additionalDuration = 1000, BordersType bordersType = BordersType.SingleStraight)

Parameters

text string

The text of the loading bar.

barWidth int

The width of the loading bar. If 0 or less than text length, text length is used.

placement Placement

The placement of the loading bar.

processDuration int

The duration of the loading bar.

additionalDuration int

The additional duration of the loading bar at the end.

bordersType BordersType

The type of borders to display around the loading bar.

Remarks

For more information, consider visiting the documentation available here.

Properties

AdditionalDuration

Gets the additional duration of the loading bar at the end.

public int AdditionalDuration { get; }

Property Value

int

BarWidth

Gets the explicit width of the loading bar.

public int BarWidth { get; }

Property Value

int

Borders

Gets the borders of the loading bar.

public Borders Borders { get; }

Property Value

Borders

BordersType

Gets the border type of the loading bar.

public BordersType BordersType { get; }

Property Value

BordersType

Height

Gets the height of the loading bar.

public override int Height { get; }

Property Value

int

Placement

Gets the placement of the loading bar.

public override Placement Placement { get; }

Property Value

Placement

ProcessDuration

Gets the duration of the loading bar.

public int ProcessDuration { get; }

Property Value

int

Text

Gets the text of the loading bar.

public string Text { get; }

Property Value

string

Width

Gets the width of the loading bar.

public override int Width { get; }

Property Value

int

Methods

RenderElementActions()

Defines the actions to perform when the element is called to be rendered on the console.

[Visual]
protected override void RenderElementActions()

UpdateAdditionalDuration(int)

Updates the additional duration of the loading bar.

public void UpdateAdditionalDuration(int additionalDuration)

Parameters

additionalDuration int

The new additional duration of the loading bar.

Remarks

For more information, consider visiting the documentation available here.

Exceptions

ArgumentOutOfRangeException

The additional duration of the loading bar cannot be negative.

UpdateBarWidth(int)

Updates the width of the loading bar.

public void UpdateBarWidth(int barWidth)

Parameters

barWidth int

The new width of the loading bar. If 0, text length is used.

Remarks

For more information, consider visiting the documentation available here.

UpdateBordersType(BordersType)

Updates the borders type of the loading bar.

public void UpdateBordersType(BordersType bordersType)

Parameters

bordersType BordersType

The new border type of the loading bar.

Remarks

For more information, consider visiting the documentation available here.

UpdatePlacement(Placement)

Updates the placement of the loading bar.

public void UpdatePlacement(Placement placement)

Parameters

placement Placement

The new placement of the loading bar.

Remarks

For more information, consider visiting the documentation available here.

UpdateProcessDuration(int)

Updates the duration of the loading bar.

public void UpdateProcessDuration(int processDuration)

Parameters

processDuration int

The new duration of the loading bar.

Remarks

For more information, consider visiting the documentation available here.

Exceptions

ArgumentOutOfRangeException

Throw when the process duration is negative.

UpdateText(string)

Updates the text of the loading bar.

public void UpdateText(string text)

Parameters

text string

The new text of the loading bar.

Remarks

For more information, consider visiting the documentation available here.