Class

MobileTextControl

Description

The parent class of MobileTextField, MobileTextArea and MobileLabel.

Events

Name

Parameters

Returns

Closing

Opening

Enumerations

MobileTextControl.Alignments

Alignments

The text alignments available to the control.

Enum

Left

Center

Right

Justified

Natural

MobileTextControl.AutoCapitalizationTypes

AutoCapitalizationTypes

The capitalization types available to the control.

Enum

None

Words

Sentences

All Characters

Property descriptions

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

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

MobileTextControl.Alignment

Alignment As Alignments

Specifies the alignment of the text in the control.

This code in the control's Opening event sets the alignment to justified:

Me.Alignment = MobileTextControl.Alignments.Justified

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

MobileTextControl.Enabled

Enabled As Boolean

Indicates whether the control is enabled or disabled.

Disable the button:

Button1.Enabled = False

MobileTextControl.Height

Height As Integer

The height of the control.

This property is read-only on iOS.

MobileTextControl.Left

Left As Integer

The left position of the control.

This property is read-only on iOS.

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

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

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

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

MobileTextControl.Name

Name As String

The name of the control.

MobileTextControl.Parent

Parent As MobileUIControl

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

This property is read-only.

MobileTextControl.SelectedText

SelectedText As String

The text that is selected.

MobileTextControl.Text

Text As String

The text in the control.

The following code sets the text of the control in any of its events:

Me.Text = "One ring to rule them all..."

MobileTextControl.TextColor

TextColor As Color

The color of the text in the control.

Placed in any of the control's events, this code changes the text color to blue:

Me.TextColor = Color.Blue

MobileTextControl.TextColor

TextColor As ColorGroup

The color of the text in the control.

Important

ColorGroup is not currently supported for Android.

MobileTextControl.TextFont

TextFont As Font

A Font object that provides information about the control's font name, font size, and more.

From any of the control's events, this example changes the font:

Me.TextFont = Font.BoldSystemFont(20)

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

MobileTextControl.Top

Top As Integer

The top position of the control.

This property is read-only on iOS.

MobileTextControl.Visible

Visible As Boolean

Indicates whether the control is visible.

Make a button invisible:

Button1.Visible = False

MobileTextControl.Width

Width As Integer

The width of the control.

This property is read-only on iOS.

Method descriptions

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

MobileTextControl.AddControl

AddControl(child As MobileUIControl)

Adds a child control to the control.

Important

This is supported for iOS only.

MobileTextControl.ClearFocus

ClearFocus

Removes the focus from the control.

TextField1.ClearFocus

MobileTextControl.ControlAt

ControlAt(index As Integer) As MobileUIControl

Gets the child control at the specified index.

Important

This is supported for iOS only.

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

MobileTextControl.Handle

Handle As Ptr

The handle to the underlying native OS control.

Important

This is supported for iOS only.

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

MobileTextControl.RemoveConstraint

RemoveConstraint(constraint As iOSLayoutConstraint)

Removes a constraint from the control.

Important

This is supported for iOS only.

MobileTextControl.RemoveControl

RemoveControl(child As MobileUIControl)

Removes the control from the control.

Important

This is supported for iOS only.

MobileTextControl.SetFocus

SetFocus

Sets the focus to the control.

TextField1.SetFocus

Event descriptions

MobileTextControl.Closing

Closing

Called when the control's layout is closing.

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

Compatibility

Mobile projects on all supported mobile operating systems.

See also

MobileUIControl parent class; MobileTextField, MobileTextArea and MobileLabel controls.