Table of Contents

Class ProgressBar

Namespace
Terminal.Gui
Assembly
Terminal.Gui.dll

A Progress Bar view that can indicate progress of an activity visually.

public class ProgressBar : View, IDisposable, ISupportInitializeNotification, ISupportInitialize, IDesignable
Inheritance
ProgressBar
Implements
Inherited Members

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.

Properties

BidirectionalMarquee

Specifies if the MarqueeBlocks or the MarqueeContinuous styles is unidirectional or bidirectional.

Fraction

Gets or sets the ProgressBar fraction to display, must be a value between 0 and 1.

ProgressBarFormat

Specifies the format that a ProgressBar uses to indicate the visual presentation.

ProgressBarStyle

Gets/Sets the progress bar style based on the ProgressBarStyle

SegmentCharacter

Segment indicator for meter views.

Text

Gets or sets the text displayed on the progress bar. If set to an empty string and ProgressBarFormat is SimplePlusPercentage the percentage will be displayed. If ProgressBarStyle is a marquee style, the text will be displayed.

Methods

EnableForDesign()

Causes the View to enable design-time mode. This typically means that the view will load demo data and be configured to allow for design-time manipulation.

OnDrawingContent()

Called when the View's content is to be drawn. The default implementation does nothing.

Pulse()

Notifies the ProgressBar that some progress has taken place.