Class # iOSProgressWheel ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
Warning
This item was deprecated in version 2020r2. Please use `MobileProgressWheel` as a replacement.
## Description The ProgressWheel is an animated spinning wheel used to indicate that a task is in process. ## Properties
table-centered_columns_3_and_4
| Name | Type | Read-Only | Shared | |-----------------------------------------------------------|------------------------------------------|-----------|--------| | `AccessibilityHint` | `Text` | | | | `AccessibilityLabel` | `Text` | | | | `Height` | `Double` | ✓ | | | `Left` | `Double` | ✓ | | | `Name` | `Text` | ✓ | | | `Parent` | `iOSControl` | ✓ | | | `Shade` | `Shades` | | | | `Top` | `Double` | ✓ | | | `Visible` | `Boolean` | | | | `Width` | `Double` | ✓ | | ## Methods
table-centered_column_4
| 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` | | | | `SetTintColor` | value As `Color` | | | ## Events
table-centered_column_4
| Name | Parameters | Returns | |---------------------------------|------------|---------| | `Close` | | | | `Open` | | | ## Enumerations
forsearch
iOSProgressWheel.Shades ### Shades Shade options (Light, Dark) for the ProgressWheel. | Enum | Description | |-------|---------------------------------| | Light | Visible on darker backgrounds. | | Dark | Visible on lighter backgrounds. | ## Property descriptions
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
iOSProgressWheel.AccessibilityHint **AccessibilityHint** As `Text` The accessibility hint is a longer description that is read aloud when VoiceOver is enabled. ``` xojo Me.AccessibilityHint = "Click to calculate the value and display the next view." ```
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
iOSProgressWheel.AccessibilityLabel **AccessibilityLabel** As `Text` The accessibility label of of a control is a short name that is read aloud when VoiceOver is enabled. ``` xojo Me.AccessibilityLabel = "Calculate the value." ```
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
iOSProgressWheel.Height **Height** As `Double` The height of the control. This property is read-only.
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
iOSProgressWheel.Left **Left** As `Double` The left position of the control. This property is read-only.
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
iOSProgressWheel.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.
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
iOSProgressWheel.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.
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
iOSProgressWheel.Shade **Shade** As `Shades` The shade of the progress wheel (light or dark). The default is Dark. Set the shade to dark: ``` xojo ProgressWheel1.Shade = iOSProgressWheel.Shade.Dark ```
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
iOSProgressWheel.Top **Top** As `Double` The top position of the control. This property is read-only.
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
iOSProgressWheel.Visible **Visible** As `Boolean` Indicates whether the control is visible. Make a button invisible: ``` xojo Button1.Visible = False ```
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
iOSProgressWheel.Width **Width** As `Double` The width of the control. This property is read-only. ## Method descriptions
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
iOSProgressWheel.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.
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
iOSProgressWheel.AddControl **AddControl**(child As `MobileControl`) Adds a child control to the control.
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
iOSProgressWheel.Control **Control**(index As `Integer`) As `MobileControl` Gets the child control at the specified index.
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
iOSProgressWheel.ControlCount **ControlCount** As `Integer` The number of child controls in the control.
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
iOSProgressWheel.Handle **Handle** As `Ptr` The handle is used to get a reference to the control for interfacing directly with the iOS API.
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
iOSProgressWheel.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: ``` xojo Canvas1.Invalidate ```
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
iOSProgressWheel.RemoveConstraint **RemoveConstraint**(constraint As `iOSLayoutConstraint`) Removes a constraint from the control.
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
iOSProgressWheel.RemoveControl **RemoveControl**(child As `MobileControl`) Removes the control from the control.
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
iOSProgressWheel.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
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
iOSProgressWheel.Close **Close** Called when the control is removed from its container, such as a view.
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
iOSProgressWheel.Open **Open** Called after the control is created. This is where you typically put initialization code. Set label text in Open event: ``` xojo Me.Text = "Hello" ``` ## Compatibility iOS projects on the iOS operating system. ## See also `MobileControl` parent class; `MobileProgressBar`