Class

MobileTextArea

Description

A multi-line text area for displaying text.

Events

Name

Parameters

Returns

Closing

Opening

SelectionChanged

TextChanged

Enumerations

MobileTextArea.BorderStyles

BorderStyles

The styles that can be used for the border of the control.

Enum

Description

None

No border.

Rectangular

A rectangular border.

Rounded

A rounded rectangular border.

Property descriptions

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

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

MobileTextArea.Alignment

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

MobileTextArea.AllowAutoCorrection

AllowAutoCorrection As Boolean

If True, some misspelled words will be automatically replaced with the correct spellings.

MobileTextArea.AllowSpellChecking

AllowSpellChecking As Boolean

If True, misspelled words will be underlined so that the user can use system-provided functions to replace them with the correct spelling.

MobileTextArea.AutoCapitalizationType

AutoCapitalizationType As MobileTextControl.AutoCapitalizationTypes

Dictates the type (if any) of automatic capitalization that should occur.

MobileTextArea.BorderStyle

BorderStyle As BorderStyles

The style for the border.

MobileTextArea.ControlCount

ControlCount As Integer

The number of child controls in the control.

This property is read-only.

MobileTextArea.Enabled

Enabled As Boolean

Indicates whether the control is enabled or disabled.

Disable the button:

Button1.Enabled = False

MobileTextArea.Height

Height As Double

The height of the control.

This property is read-only.

MobileTextArea.Left

Left As Double

The left position of the control.

This property is read-only.

MobileTextArea.Name

Name As String

The name of the control.

MobileTextArea.Parent

Parent As MobileUIControl

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

This property is read-only.

MobileTextArea.ReadOnly

ReadOnly As Boolean

Indicates if the text is read-only.

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

MobileTextArea.TextColor

TextColor As ColorGroup

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

MobileTextArea.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.Font = Font.BoldSystemFont(20)

MobileTextArea.TintColor

TintColor As ColorGroup

Changes a control's tint color.

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.

MobileTextArea.Top

Top As Double

The top position of the control.

This property is read-only.

MobileTextArea.Visible

Visible As Boolean

Indicates whether the control is visible.

Make a button invisible:

Button1.Visible = False

MobileTextArea.Width

Width As Double

The width of the control.

This property is read-only.

Method descriptions

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

MobileTextArea.AddControl

AddControl(child As MobileUIControl)

Adds a child control to the control.

MobileTextArea.ClearFocus

ClearFocus

Removes the focus from the control.

TextField1.ClearFocus

MobileTextArea.ControlAt

ControlAt(index As Integer) As MobileUIControl

Gets the child control at the specified index.

MobileTextArea.Controls

Controls As Iterable

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

MobileTextArea.Handle

Handle As Ptr

The a handle to the underlying native OS control.

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

MobileTextArea.RemoveConstraint

RemoveConstraint(constraint As iOSLayoutConstraint)

Removes a constraint from the control.

MobileTextArea.RemoveControl

RemoveControl(child As MobileUIControl)

Removes the control from the control.

MobileTextArea.SetFocus

SetFocus

Sets the focus to the control.

TextField1.SetFocus

Event descriptions

MobileTextArea.Closing

Closing

Called when the control's layout is closing.

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

MobileTextArea.SelectionChanged

SelectionChanged

Called when the text selection has changed.

MobileTextArea.TextChanged

TextChanged

Called when the text changes.

Update a label with the text as it changes:

DescLabel.Text = Me.Text

Compatibility

Mobile projects on all supported mobile operating systems.

See also

MobileTextControl parent class; MobileTextField control