Class ProgressBar
A Progress Bar view that can indicate progress of an activity visually.
Implements
System.IDisposable
System.ComponentModel.ISupportInitializeNotification
System.ComponentModel.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.
Inherited Members
Namespace: Terminal.Gui
Assembly: Terminal.Gui.dll
Syntax
public class ProgressBar : ViewConstructors
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
BidirectionalMarquee
Specifies if the MarqueeBlocks or the
MarqueeContinuous styles is unidirectional
or bidirectional.
Declaration
public bool BidirectionalMarquee { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
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. |
ProgressBarFormat
Specifies the format that a ProgressBar uses to indicate the visual presentation.
Declaration
public ProgressBarFormat ProgressBarFormat { get; set; }Property Value
| Type | Description |
|---|---|
| ProgressBarFormat |
ProgressBarStyle
Gets/Sets the progress bar style based on the ProgressBarStyle
Declaration
public ProgressBarStyle ProgressBarStyle { get; set; }Property Value
| Type | Description |
|---|---|
| ProgressBarStyle |
SegmentCharacter
Segment indicator for meter views.
Declaration
public Rune SegmentCharacter { get; set; }Property Value
| Type | Description |
|---|---|
| System.Rune |
Text
The text displayed by the View.
Declaration
public override ustring Text { get; set; }Property Value
| Type | Description |
|---|---|
| NStack.ustring |
Overrides
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()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
Implements
System.IDisposable
System.ComponentModel.ISupportInitializeNotification
System.ComponentModel.ISupportInitialize