ProgressBar

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.1.0.0)

• Control
  • ProgressBar

Represents a progress control that displays a value visually as a filled bar.

C#

public class ProgressBar : Control

VB.NET

Public Class ProgressBar
    Inherits Control

Constructors

ProgressBar()

Initializes a new instance of the ProgressBar class.

ProgressBar(location, size)

Initializes a new instance of the ProgressBar class with the specified settings. Sets the Location and Size properties based on the provided parameters.

Name	Type	Description
location	Point	The location of the progress bar on its parent control.
size	Size	The size of the progress bar.

Properties

BarColor

Color: Returns or sets the color of the progress bar portion.

BorderStyle

BorderStyle: Indicates the border style for the control. (Default: None)

DefaultSize

Size: Returns the default size of the control.

Maximum

Int32: Returns or sets the maximum value of the range of the control. (Default: 100)

Throws:

• ArgumentException The value specified is less than 0.

Minimum

Int32: Returns or sets the minimum value of the range of the control. (Default: 0)

Throws:

• ArgumentException The value specified for the property is less than 0.

Step

Int32: Returns or sets the amount by which a call to the PerformStep method increases the current position of the progress bar. (Default: 10)

Value

Int32: Returns or sets the current position of the progress bar. (Default: 0)

Throws:

• ArgumentException The value specified is greater than the value of the Maximum property; or the value specified is less than the value of the Minimum property.

Methods

Increment(value)

Advances the current position of the progress bar by the specified amount.

Parameter	Type	Description
value	Int32	The amount by which to increment the progress bar's current position.

OnWebRender(config)

Renders the client component.

Parameter	Type	Description
config	Object	Dynamic configuration object.

PerformStep()

Advances the current position of the progress bar by the amount of the Step property.

Implements

Name	Description
IUserData	Provides access to the UserData and Tag properties associated to the component implementing this interface.
IBindableComponent	Bindable components implement this interface.
IDropTarget	Controls that support drag & drop operations implement this interface.
IWisejComponent	All wisej components implement this interface.
IWisejControl	All wisej controls derived from the Control class must implement this interface.
IWisejSerializable	Allows an object to serialize itself.