Class

iOSScrollableArea

Warning

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

Description

A scrollable area allows users to view content that is larger than the size of the view itself. This control has one child control that is treated as the content. It determines when scrolling is required by applying the control's auto layout rules and comparing the required size to its own size.

Events

Name

Parameters

Returns

Close

Open

Property descriptions

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

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

iOSScrollableArea.Content

Content As iOSContainerControl

The container control whose contents will be scrollable if it does not fit entirely within the scrollable area control.

To get the container control so that you can reference methods (or controls) on it:

' Get reference to container control
Var cc As MyContainer
cc = MyContainer(ScrollableArea1.Content) ' cast to MyContainer

' Now you can call methods on it
cc.UpdateData

iOSScrollableArea.Height

Height As Double

The height of the control.

This property is read-only.

iOSScrollableArea.Left

Left As Double

The left position of the control.

This property is read-only.

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

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

iOSScrollableArea.Top

Top As Double

The top position of the control.

This property is read-only.

iOSScrollableArea.Visible

Visible As Boolean

Indicates whether the control is visible.

Make a button invisible:

Button1.Visible = False

iOSScrollableArea.Width

Width As Double

The width of the control.

This property is read-only.

Method descriptions

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

iOSScrollableArea.AddControl

AddControl(child As MobileControl)

Adds a child control to the control.

iOSScrollableArea.Control

Control(index As Integer) As MobileControl

Gets the child control at the specified index.

iOSScrollableArea.ControlCount

ControlCount As Integer

The number of child controls in the control.

iOSScrollableArea.Handle

Handle As Ptr

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

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

iOSScrollableArea.RemoveConstraint

RemoveConstraint(constraint As iOSLayoutConstraint)

Removes a constraint from the control.

iOSScrollableArea.RemoveControl

RemoveControl(child As MobileControl)

Removes the control from the control.

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

iOSScrollableArea.Close

Close

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

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

Notes

A scrollable area can scroll vertically, horizontally or both.

Compatibility

iOS projects on the iOS operating system.

See also

MobileControl parent class; MobileContainer