Class

iOSProgressBar


Warning

This item was deprecated in version 2020r2. Please use MobileProgressBar as a replacement.

Description

The ProgressBar is used to display progress using a horizontal line.

Methods

Name

Parameters

Returns

Shared

AddConstraint

constraint As iOSLayoutConstraint

AddControl

child As MobileControl

Control

index As Integer

MobileControl

ControlCount

Integer

Handle

Ptr

Invalidate

RemoveConstraint

constraint As iOSLayoutConstraint

RemoveControl

child As MobileControl

SetMinCurrentMax

minValue As Double, currentValue As Double, maxValue As Double

SetTintColor

value As Color

Events

Name

Parameters

Returns

Close

Open

Property descriptions


iOSProgressBar.AccessibilityHint

AccessibilityHint As Text

The accessibility hint is a longer description that is read aloud when VoiceOver is enabled.

Me.AccessibilityHint = "Click to calculate the value and display the next view."

iOSProgressBar.AccessibilityLabel

AccessibilityLabel As Text

The accessibility label of of a control is a short name that is read aloud when VoiceOver is enabled.

Me.AccessibilityLabel = "Calculate the value."

iOSProgressBar.Height

Height As Double

The height of the control.

This property is read-only.


iOSProgressBar.Left

Left As Double

The left position of the control.

This property is read-only.


iOSProgressBar.MaxValue

MaxValue As Double

The maximum value of the progress bar. When CurrentValue reaches MaxValue, the progress bar appears "full".

Only update the current value if it is below the maximum:

If MyProgressBar.Value < MyProgressBar.MaxValue Then
  MyProgressBar.Value = MyProgressBar.Value + 1
End If

iOSProgressBar.MinValue

MinValue As Double

The minimum value of the progress bar. When CurrentValue is MinValue, the progress bar appears "empty".

Use a non-zero minimum value:

Me.MinValue = 15

iOSProgressBar.Name

Name As Text

The name of the control. This can only be set in the Inspector. Use the name to refer to the control.

This property is read-only.


iOSProgressBar.Parent

Parent As iOSControl

Indicates the control's parent object, if it has one. If there is no parent, this is Nil.

This property is read-only.


iOSProgressBar.Top

Top As Double

The top position of the control.

This property is read-only.


iOSProgressBar.Value

Value As Double

The current value of the progress bar.

Increase the current position (usually done from a Timer):

MyProgressBar.Value = MyProgressBar.Value + 1

iOSProgressBar.Visible

Visible As Boolean

Indicates whether the control is visible.

Make a button invisible:

Button1.Visible = False

iOSProgressBar.Width

Width As Double

The width of the control.

This property is read-only.

Method descriptions


iOSProgressBar.AddConstraint

AddConstraint(constraint As iOSLayoutConstraint)

Adds a constraint to the control. This constraint is used by child controls that have been added to this control.


iOSProgressBar.AddControl

AddControl(child As MobileControl)

Adds a child control to the control.


iOSProgressBar.Control

Control(index As Integer) As MobileControl

Gets the child control at the specified index.


iOSProgressBar.ControlCount

ControlCount As Integer

The number of child controls in the control.


iOSProgressBar.Handle

Handle As Ptr

The handle is used to get a reference to the control for interfacing directly with the iOS API.


iOSProgressBar.Invalidate

Invalidate

Marks the control so that it will be redrawn during the next event loop.

Call Invalidate to force a Canvas to redraw itself:

Canvas1.Invalidate

iOSProgressBar.RemoveConstraint

RemoveConstraint(constraint As iOSLayoutConstraint)

Removes a constraint from the control.


iOSProgressBar.RemoveControl

RemoveControl(child As MobileControl)

Removes the control from the control.


iOSProgressBar.SetMinCurrentMax

SetMinCurrentMax(minValue As Double, currentValue As Double, maxValue As Double)

Sets all the properties at one time.

Using this method is more efficient than setting the properties individually. It also avoids the animation that may show when you update the properties separately.

Set all values at once:

Me.SetMinCurrentMax(0, 15, 100)

iOSProgressBar.SetTintColor

SetTintColor(value As Color)

Changes a control's tint color. This varies by control and for some controls may not do anything. For example, with an MobileTextField this changes the cursor color.

Event descriptions


iOSProgressBar.Close

Close

Called when the control is removed from its container, such as a view.


iOSProgressBar.Open

Open

Called after the control is created. This is where you typically put initialization code.

Set label text in Open event:

Me.Text = "Hello"

Compatibility

iOS projects on the iOS operating system.

See also

MobileControl parent class; MobileProgressWheel