Class

MobileSwitch

Description

A Switch control is used to indicate an on/off, yes/no or true/false selection.

Properties

Name	Type	Read-Only
AccessibilityHint	String
AccessibilityLabel	String
ControlCount	Integer	✓
Enabled	Boolean
Height	Integer	✓
Left	Integer	✓
LockBottom	Boolean
LockLeft	Boolean
LockRight	Boolean
LockTop	Boolean
Name	String
Parent	MobileUIControl	✓
TintColor	ColorGroup
Top	Integer	✓
Value	Boolean
Visible	Boolean
Width	Integer	✓

Methods

Name	Parameters	Returns
AddConstraint	constraint As iOSLayoutConstraint
AddControl	child As MobileUIControl
ClearFocus
ControlAt	index As Integer	MobileUIControl
Controls		Iterable
Handle		Ptr
Refresh
RemoveConstraint	constraint As iOSLayoutConstraint
RemoveControl	child As MobileUIControl
SetFocus

Events

Name	Parameters	Returns
Closing
Opening
ValueChanged

Property descriptions

MobileSwitch.AccessibilityHint

AccessibilityHint As String

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 screen."

MobileSwitch.AccessibilityLabel

AccessibilityLabel As String

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

Me.AccessibilityLabel = "Calculate the value."

MobileSwitch.ControlCount

ControlCount As Integer

The number of child controls in the control.

This property is read-only.

Important

This property is supported for iOS only.

MobileSwitch.Enabled

Enabled As Boolean

Indicates whether the control is enabled or disabled.

Disable the button:

Button1.Enabled = False

MobileSwitch.Height

Height As Integer

The height of the control.

This property is read-only on iOS.

MobileSwitch.Left

Left As Integer

The left position of the control.

This property is read-only on iOS.

MobileSwitch.LockBottom

LockBottom As Boolean

Determines whether the bottom edge of the control should stay at a set distance from the bottom edge of the parent control, if there is one, or the owning screen.

Important

This property is not currently supported for iOS. Use constraints instead.

This property can be set in the control's Inspector. The following example sets it in code.

Me.LockBottom = True

MobileSwitch.LockLeft

LockLeft As Boolean

Determines whether the left edge of the control should stay at a set distance from the left edge of the parent control, if there is one, or the owning screen.

LockLeft and Locktop default to True when you add a new control to a screen. Existing controls will be altered only if LockRight and/or LockBottom are not set. LockLeft has no effect unless LockRight is True.

Important

This property is not currently supported for iOS. Use constraints instead.

This property can be set in the control's Inspector. The following example sets it in code.

Me.LockLeft = True

MobileSwitch.LockRight

LockRight As Boolean

Determines whether the right edge of the control should stay at a set distance from the right edge of the parent control, if there is one, or the owning screen.

Important

This property is not currently supported for iOS. Use constraints instead.

This property can be set in the control's Inspector. The following example sets it in code.

Me.LockRight = True

MobileSwitch.LockTop

LockTop As Boolean

Determines whether the top edge of the control should stay at a set distance from the top edge of the parent control, if there is one, or the owning screen.

LockTop and LockLeft default to True when you add a control to a screen. Existing controls will be altered only if LockRight and/or LockBottom are not set. LockTop has no effect unless LockBottom is True.

Important

This property is not currently supported for iOS. Use constraints instead.

This property can be set in the control's Inspector. The following example sets it in code.

Me.LockTop = True

MobileSwitch.Name

Name As String

The name of the control.

MobileSwitch.Parent

Parent As MobileUIControl

The parent (sometimes called a "Super") class of the control.

This property is read-only.

MobileSwitch.TintColor

TintColor As ColorGroup

Changes a control's tint color.

Important

This is supported for iOS only.

On iOS, the following controls support TintColor:

Enum	Description
ProgressBar	The area indicating the value of the control will be drawn in the TintColor.
Slider	The area indicating the value of the control will be drawn in the TintColor.
TextArea	The cursor and text highlight color will be drawn in the TintColor.
TextField	The cursor and text highlight color will be drawn in the TintColor.

MobileSwitch.Top

Top As Integer

The top position of the control.

This property is read-only on iOS.

MobileSwitch.Value

Value As Boolean

The value of the switch. On = True, Off = False.

If the Tax switch is on, then set the tax rate:

Var tax As Currency
If TaxSwitch.Value Then
  tax = 0.08
End If

MobileSwitch.Visible

Visible As Boolean

Indicates whether the control is visible.

Make a button invisible:

Button1.Visible = False

MobileSwitch.Width

Width As Integer

The width of the control.

This property is read-only on iOS.

Method descriptions

MobileSwitch.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.

Important

This is supported for iOS only.

MobileSwitch.AddControl

AddControl(child As MobileUIControl)

Adds a child control to the control.

Important

This is supported for iOS only.

MobileSwitch.ClearFocus

ClearFocus

Removes the focus from the control.

TextField1.ClearFocus

MobileSwitch.ControlAt

ControlAt(index As Integer) As MobileUIControl

Gets the child control at the specified index.

Important

This is supported for iOS only.

MobileSwitch.Controls

Controls As Iterable

Allows you to iterate through all the controls that have been added to this control.

Important

This is supported for iOS only.

MobileSwitch.Handle

Handle As Ptr

The handle to the underlying native OS control.

MobileSwitch.Refresh

Refresh

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

Call Refresh to force a Canvas to redraw itself:

Canvas1.Refresh

MobileSwitch.RemoveConstraint

RemoveConstraint(constraint As iOSLayoutConstraint)

Removes a constraint from the control.

Important

This is supported for iOS only.

MobileSwitch.RemoveControl

RemoveControl(child As MobileUIControl)

Removes the control from the control.

Important

This is supported for iOS only.

MobileSwitch.SetFocus

SetFocus

Sets the focus to the control.

TextField1.SetFocus

Event descriptions

MobileSwitch.Closing

Closing

Called when the control's layout is closing.

MobileSwitch.Opening

Opening

Called when the control's layout is opening.

This is where you typically put initialization code.

This example in the Opening event of a label sets its text to "Hello":

Me.Text = "Hello"

MobileSwitch.ValueChanged

ValueChanged

Called when the value property is changed either by code or by the user.

Disable a MobileTextField when the switch is off and enable it when on:

If Me.Value Then
  MyTextField.Enabled = True
Else
  MyTextField.Enabled = False
End If

Compatibility

Mobile projects on all supported mobile operating systems.