Class ProgressBar

A Progress Bar view that can indicate progress of an activity visually.
Inheritance
object
Responder
View
ProgressBar
Implements
Inherited Members
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

| Edit this page View Source

ProgressBar()

Initializes a new instance of the ProgressBar class, starts in percentage mode and uses relative layout.
Declaration
public ProgressBar()
| Edit this page View Source

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

| Edit this page View Source

BidirectionalMarquee

Specifies if the MarqueeBlocks or the MarqueeContinuous styles is unidirectional or bidirectional.
Declaration
public bool BidirectionalMarquee { get; set; }
Property Value
Type Description
bool
| Edit this page View Source

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
float The fraction representing the progress.
| Edit this page View Source

ProgressBarFormat

Specifies the format that a ProgressBar uses to indicate the visual presentation.
Declaration
public ProgressBarFormat ProgressBarFormat { get; set; }
Property Value
Type Description
ProgressBarFormat
| Edit this page View Source

ProgressBarStyle

Gets/Sets the progress bar style based on the ProgressBarStyle
Declaration
public ProgressBarStyle ProgressBarStyle { get; set; }
Property Value
Type Description
ProgressBarStyle
| Edit this page View Source

SegmentCharacter

Segment indicator for meter views.
Declaration
public Rune SegmentCharacter { get; set; }
Property Value
Type Description
Rune
| Edit this page View Source

Text

The text displayed by the View.
Declaration
public override ustring Text { get; set; }
Property Value
Type Description
ustring
Overrides
Remarks

If provided, the text will be drawn before any subviews are drawn.

The text will be drawn starting at the view origin (0, 0) and will be formatted according to the TextAlignment property. If the view's height is greater than 1, the text will word-wrap to additional lines if it does not fit horizontally. If the view's height is 1, the text will be clipped.

Set the HotKeySpecifier to enable hotkey support. To disable hotkey support set HotKeySpecifier to (Rune)0xffff.

Methods

| Edit this page View Source

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
bool true, if the event was handled, false otherwise.
Overrides
| Edit this page View Source

Pulse()

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

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 parameter, as this will cause the driver to clip the entire region.

Implements