Class ProgressBar

A Progress Bar view that can indicate progress of an activity visually.
Inheritance
System.Object
Responder
View
ProgressBar
Implements
System.IDisposable
System.ComponentModel.ISupportInitializeNotification
System.ComponentModel.ISupportInitialize
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: Terminal.Gui
Assembly: Terminal.Gui.dll
Syntax
public class ProgressBar : View, IDisposable, ISupportInitializeNotification, ISupportInitialize
Remarks

ProgressBar can operate in two modes, percentage mode, or activity mode. The progress bar starts in percentage mode and setting the Fraction property will reflect on the UI the progress made so far. Activity mode is used when the application has no way of knowing how much time is left, and is started when the Pulse() method is called. Call Pulse() repeatedly as progress is made.

Constructors

ProgressBar()

Initializes a new instance of the ProgressBar class, starts in percentage mode and uses relative layout.
Declaration
public ProgressBar()

ProgressBar(Rect)

Initializes a new instance of the ProgressBar class, starts in percentage mode with an absolute position and size.
Declaration
public ProgressBar(Rect rect)
Parameters
Type Name Description
Rect rect Rect.

Properties

Fraction

Gets or sets the ProgressBar fraction to display, must be a value between 0 and 1.
Declaration
public float Fraction { get; set; }
Property Value
Type Description
System.Single The fraction representing the progress.

Methods

OnEnter(View)

Method invoked when a view gets focus.
Declaration
public override bool OnEnter(View view)
Parameters
Type Name Description
View view The view that is losing focus.
Returns
Type Description
System.Boolean true, if the event was handled, false otherwise.
Overrides

Pulse()

Notifies the ProgressBar that some progress has taken place.
Declaration
public void Pulse()
Remarks
If the ProgressBar is is percentage mode, it switches to activity mode. If is in activity mode, the marker is moved.

Redraw(Rect)

Redraws this view and its subviews; only redraws the views that have been flagged for a re-display.
Declaration
public override void Redraw(Rect region)
Parameters
Type Name Description
Rect region
Overrides
Remarks

Always use Bounds (view-relative) when calling Redraw(Rect), NOT Frame (superview-relative).

Views should set the color that they want to use on entry, as otherwise this will inherit the last color that was set globally on the driver.

Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region larger than the region parameter.

Implements

System.IDisposable
System.ComponentModel.ISupportInitializeNotification
System.ComponentModel.ISupportInitialize