ProgressBar Class

Viewport progress bar.
Public Class ProgressBar 
Inherits BarBase 
Implements IDisposable, _ 
ICloneable
This language is not supported or no code example is available.
public class ProgressBar : BarBase
IDisposable
ICloneable
This language is not supported or no code example is available.
Name Description
Public property AnimationInterval Gets or set the animation interval for continuous progress bar.
Public property CancelButton Gets or sets the Cancel button.
Public property CancellingText Gets or sets the progress bar "Cancelling..." text shown during the cancelling of the WorkUnit.
Public property Color Gets or sets the progress bar color.
Protected property CustomViewport Tells if the UI element is drawn with a custom viewport. (inherited from UserInterfaceBase).
Public property Disposed (inherited from DisposableBase).
Public property DrawScale Gets or sets the scale of the progress bar.
Internal protected (Protected Friend) property Static HighestNumberOfTicks
Public property Lighting When false, the UI element is drawn with a flat color.
Protected property LocationAtOrigin When doing a render to Bitmap of the item, must not change the viewport origin. (inherited from UserInterfaceBase).
Internal protected (Protected Friend) property ParentEnvironment
Internal protected (Protected Friend) property ParentViewport
Public property ShowPercentText Gets or sets the percent text visibility status.
Public property StyleMode Gets or sets the progress bar style.
Public property Text Gets or sets the progress bar text.
Public property TextBackgroundColor Gets or sets the progress bar text background color.
Public property TextColor Gets or sets the progress bar text color.
Public property ThicknessFactor Gets or sets progress bar thickness factor (range 0-1).
Public property Value Gets or sets the progress bar value.
Public property ViewportIndex Gets the index of the viewport on which the progress bar is displayed.
Public property Visible Gets or sets the progress bar visibility during the WorkUnit asynchronous execution.
Top
Methods
 
Name Description
Public method Clone() Creates a new object that is a copy of the current instance.
Protected method ComputeCircular(Viewport, out double, out double, out double[])
Public method Contains(Point) Tells if a point in viewport coordinates is over one of the buttons.
Public method Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Internal protected (Protected Friend) method Draw(DrawSceneParams)
Protected method DrawCircular(RenderContextBase, double, double, Viewport, Color, Color)
Protected method DrawCircularContinuous(RenderContextBase, double, double, Viewport, Color, Color)
Protected method DrawDocked(RenderContextBase, int, int, int, Color, Color)
Protected method DrawDockedContinuous(RenderContextBase, int, int, int, Color, Color)
Protected method DrawForBitmap(object) (inherited from BarBase).
Protected method DrawLinear(RenderContextBase, int, int, int, int, Color, Color)
Protected method DrawLinearContinuous(RenderContextBase, int, int, int, int, Color, Color)
Protected method DrawProgressCircularTick(RenderContextBase, double[])
Public method Equals(Object) Determines whether the specified object is equal to the current object. (inherited from Object).
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (inherited from Object).
Public method GetBounds(Viewport) Gets the bounds rectangle in screen coordinates.
Protected method GetColors(Viewport, out Color, out Color)
Internal protected (Protected Friend) method GetDefaultLayerName(Environment) Use this method to get the correct layer name for internal Meshes. (inherited from UserInterfaceBase).
Public method GetHashCode Serves as the default hash function. (inherited from Object).
Public method GetThumbnail(Viewport, Size, Color) (inherited from BarBase).
Public method GetType Gets the Type of the current instance. (inherited from Object).
Protected method Hover(Environment, ToolBarButton) (inherited from BarBase).
Protected method MemberwiseClone Creates a shallow copy of the current Object. (inherited from Object).
Internal protected (Protected Friend) method ObservableCollectionPropertyChanged(object, NotifyCollectionChangedEventArgs) For internal use only. (inherited from DisposableBase).
Protected method OnMouseDown(Environment, MouseEventArgs) (inherited from BarBase).
Protected method RaisePropertyChangedEvent(object, DependencyProperty) For internal use only. (inherited from DisposableBase).
Protected method Static Repaint(Environment) (inherited from BarBase).
Public method ScaleForDPI() Scales the element for high DPI settings. (inherited from UserInterfaceBase).
Public method ToString Returns a string that represents the current object. (inherited from Object).
Public method Update(IUserInterfaceElement) Updates the contents of the element with the data from another element.
Top
Events
 
Name Description
Public event PropertyChanged For internal use only. (inherited from DisposableBase).
Top
Name Description
Public enumeration styleType Progress bar style type.
Top
Fields
 
Name Description
Public field Static PropertyChangedEvent For internal use only. (inherited from DisposableBase).
Top

.NET Framework

Supported in: 4.5, 4.6, 4.7

In this article

Definition