Class ProgressBar
Definition
- Namespace:
- ElmSharp
- Assembly:
- ElmSharp.dll
- API Level:
- preview
The ProgressBar is a widget for visually representing the progress status of a given job or task.
C#Copypublic class ProgressBar : Layout, IAccessibleObject
- Inheritance
- Implements
Constructors
ProgressBar(EvasObject)
Creates and initializes a new instance of the ProgressBar class.
Declaration
C#Copypublic ProgressBar(EvasObject parent)
Parameters
| Type | Name | Description |
|---|---|---|
| EvasObject | parent | The EvasObject to which the new ProgressBar will be attached as a child. |
API Level: preview
Properties
Declaration
C#Copypublic override Color Color { get; set; }
Property Value
| Type | Description |
|---|---|
| Color |
Overrides
API Level: preview
Declaration
C#Copypublic bool IsHorizontal { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
API Level: preview
IsInverted
Sets or gets the value whether a given progress bar widget's displaying values are inverted.
Declaration
C#Copypublic bool IsInverted { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
API Level: preview
IsPulseMode
Sets or gets the value whether a given ProgressBar widget is at the "pulsing mode".
Declaration
C#Copypublic bool IsPulseMode { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
Remarks
By default, progress bars display values from low to high value boundaries. There are, though, contexts in which the progress of a given task is unknown. For such cases, one can set the progress bar widget to a "pulsing state", to give the user an idea that some computation is being held, but without the exact progress values. In the default theme, it animates its bar with the contents filling in constantly and back to non-filled, in a loop.
API Level: preview
Declaration
C#Copypublic int SpanSize { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Int32 |
API Level: preview
UnitFormat
Sets or gets the format string for a given progress bar widget's units label.
Declaration
C#Copypublic string UnitFormat { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
Remarks
If null is passed on format, it makes the object units area to be hidden completely. If not, it sets the format string for the units label's text. The units label are provided with a floating point value, so the units text displays at the most one floating point value. Note that the units label is optional. Use a format string such as "%1.2f meters" for example.
API Level: preview
Declaration
C#Copypublic double Value { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Double |
Remarks
Use this property to set the progress bar levels. If you pass a value out of the specified range (0.0~1.0), it is interpreted as the closest of the boundary values in the range.
API Level: preview
Methods
Declaration
C#Copyprotected override IntPtr CreateHandle(EvasObject parent)
Parameters
| Type | Name | Description |
|---|---|---|
| EvasObject | parent | Parent EvasObject. |
Returns
| Type | Description |
|---|---|
| System.IntPtr | Handle IntPtr. |
Overrides
API Level: preview
Declaration
C#Copypublic double GetPartValue(string part)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | part | Part of the Progressbar. |
Returns
| Type | Description |
|---|---|
| System.Double | Value range is from 0.0 to 1.0. |
API Level: preview
Declaration
C#Copypublic void PlayPulse()
API Level: preview
Declaration
C#Copypublic void SetPartValue(string part, double value)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | part | Part of the Progressbar. |
| System.Double | value | Value range is from 0.0 to 1.0. |
API Level: preview
Declaration
C#Copy[Obsolete("use StopPulse instead")] public void StopPluse()
API Level: preview
Declaration
C#Copypublic void StopPulse()
API Level: preview
Events
Declaration
C#Copypublic event EventHandler ValueChanged
Event Type
| Type | Description |
|---|---|
| System.EventHandler |