Class ScrollViewConceptMetadata

Defines properties and message types for ScrollViewConcept.

Property Types

See also PropertyType
ScrollViewConceptMetadata.RecognitionThresholdProperty

Sets the amount a pointing device must move for the scrolling to start on a Scroll View node.

ScrollViewConceptMetadata.MinimumNumberOfTouchesProperty

Sets the required number of touch points pressed for a Scroll View node pan to start. Scroll View nodes with minimum number of touches greater than one precede the children in touch processing.

ScrollViewConceptMetadata.MaximumNumberOfTouchesProperty

Sets the maximum number of touch points allowed for a Scroll View pan.

ScrollViewConceptMetadata.SensitivityProperty

Sets the amount the position changes relative to the movement of the pointer that starts the swiping. The higher the value the more the position of the node controlled by a Scroll View node changes. The default value is 1.

ScrollViewConceptMetadata.SlidingAccelerationCoefficientProperty

Sets the acceleration of the node controlled by a Scroll View node after you release the pointer with which you swipe. Use low values when you want that node to slowly reach the final position. Use high values when you want that node to quickly reach the final position.

ScrollViewConceptMetadata.SlidingDragCoefficientProperty

Sets the amount that drag affects the movement of the node controlled by a Scroll View node after you release the pointer with which you swipe. The lower the value the higher the drag and the faster the sliding of the object controlled by the Scroll View node stops.

ScrollViewConceptMetadata.DraggingAccelerationCoefficientProperty

Sets the acceleration of the node controlled by a Scroll View node while you drag that Scroll View node. Use low values when you want that node to slowly reach the final position. Use high values when you want that node to quickly reach the final position.

ScrollViewConceptMetadata.DraggingDragCoefficientProperty

Sets the amount that drag affects the movement of the node controlled by a Scroll View node while you drag that Scroll View node. The lower the value the higher the drag and the faster the sliding of that node stops.

ScrollViewConceptMetadata.DraggingImpulseFactorProperty

Sets the amount of impulse generated from the pointing device movement when dragging a Scroll View node.

ScrollViewConceptMetadata.SwipeDistanceProperty

Sets the distance that a swipe sends the scroll value, relative to the pointing device speed.

ScrollViewConceptMetadata.ScrollPositionProperty

Sets the scroll position of the Scroll View along the x and y axes as a relative position within the scroll view area. Use this property to set the scroll position immediately, without scrolling. To update the scroll position with a binding, use a two-way or to-source binding.

ScrollViewConceptMetadata.ScrollTargetPositionProperty

The current target scroll value (read-only).

ScrollViewConceptMetadata.ScrollSpeedProperty

The current scroll speed (read-only).

ScrollViewConceptMetadata.ScrollingProperty

Whether a Scroll View node is currently scrolling (read-only).

ScrollViewConceptMetadata.ZoomAffectsScrollingProperty

Controls whether the scroll position is scaled, according to the zoom level.

ScrollViewConceptMetadata.ScrollBoundsMinimumProperty

Sets the coordinates of the top-left corner of the scroll bounds rectangle. Scroll bounds define where the scrolling begins and ends.

ScrollViewConceptMetadata.ScrollBoundsMaximumProperty

Sets the coordinates of the bottom-right corner of the scroll bounds rectangle. Scroll bounds define where the scrolling begins and ends.

ScrollViewConceptMetadata.LoopingXEnabledProperty

Sets the node controlled by a Scroll View node to start scrolling from the beginning when the scroll reaches the scroll bounds on the x axis. When the scroll value reaches the maximum value of the bound, the value changes to the minimum value and the other way around. Use the Scroll Bounds Minimum and Scroll Bounds Maximum properties to set the scroll bounds.

ScrollViewConceptMetadata.LoopingYEnabledProperty

Sets the node controlled by a Scroll View node to start scrolling from the beginning when the scroll reaches the scroll bounds on the y axis. When the scroll value reaches the maximum value of the bound, the value changes to the minimum value and the other way around. Use the Scroll Bounds Minimum and Scroll Bounds Maximum properties to set the scroll bounds.

ScrollViewConceptMetadata.ZoomEnabledProperty

Sets whether to install a pinch manipulator that generates zoom messages.

ScrollViewConceptMetadata.ZoomProperty

Sets the current zoom level.

ScrollViewConceptMetadata.ZoomMinimumProperty

Sets the minimum zoom level.

ScrollViewConceptMetadata.ZoomMaximumProperty

Sets the maximum zoom level.

ScrollViewConceptMetadata.StepMultiplierProperty

Sets the smallest distance that a Scroll View scrolls.

ScrollViewConceptMetadata.AllowedScrollAxisProperty

Sets the axis on which you want to allow this Scroll View node to scroll.

ScrollViewConceptMetadata.ReversedXAxisScrollProperty

Whether the scroll position of the x axis increases in relation to the direction of the pan gesture. This reverses the direction of scrolling. By default, the scroll position decreases in relation to the pan direction.

ScrollViewConceptMetadata.ReversedYAxisScrollProperty

Whether the scroll position of the y axis increases in relation to the direction of the pan gesture. This reverses the direction of scrolling. By default, the scroll position decreases in relation to the pan direction.

Message Types

See also MessageType
ScrollViewConceptMetadata.ScrollStartedMessage

Occurs when the scroll position of a Scroll View node starts changing.

Arguments: ScrollViewConceptMetadata.ScrollStartedMessageArguments

ScrollViewConceptMetadata.ScrollEndedMessage

Occurs when the scroll position of a Scroll View node stops changing.

Arguments: ScrollViewConceptMetadata.ScrollFinishedMessageArguments

ScrollViewConceptMetadata.ZoomedMessage

Occurs when the zoom level of a Scroll View node changes.

Arguments: ScrollViewConceptMetadata.ZoomedMessageArguments

ScrollViewConceptMetadata.ScrolledMessage

Occurs when the scroll position of a Scroll View node changes.

Arguments: ScrollViewConceptMetadata.ScrolledMessageArguments

ScrollViewConceptMetadata.UserScrollStartedMessage

Occurs when the user starts scrolling a Scroll View node.

Arguments: ScrollViewConceptMetadata.UserScrollStartedMessageArguments

ScrollViewConceptMetadata.UserScrollEndedMessage

Occurs when the user stops scrolling a Scroll View node.

Arguments: ScrollViewConceptMetadata.UserScrollFinishedMessageArguments

ScrollViewConceptMetadata.SetScrollTargetMessage

Sets the scrolling target of the scroll view.

Arguments: ScrollViewConceptMetadata.SetScrollTargetMessageArguments

ScrollViewConceptMetadata.SetScrollMessage

Sets the scroll position of a Scroll View node.

Arguments: ScrollViewConceptMetadata.SetScrollMessageArguments

ScrollViewConceptMetadata.SnapRequestMessage

Occurs when a Scroll View node requests snapping target from the hosting component.

Arguments: ScrollViewConceptMetadata.SnapRequestMessageArguments

ScrollViewConceptMetadata.ScrollDirectionMessage

Sets the scroll delta to one step and starts scrolling in that direction

Arguments: ScrollViewConceptMetadata.ScrollDirectionMessageArguments

ScrollViewConceptMetadata.ScrollPageMessage

Sets the scroll delta to one page and starts scrolling in that direction

Arguments: ScrollViewConceptMetadata.ScrollPageMessageArguments

ScrollViewConceptMetadata.ScrollEdgeMessage

Sets the scroll target to the edge of a Scroll View node and starts scrolling in that direction

Arguments: ScrollViewConceptMetadata.ScrollEdgeMessageArguments

ScrollViewConceptMetadata.ScrollUpMessage

Sets the scroll delta to one step up and starts scrolling in that direction. Use this action to scroll a Scroll View or Grid List Box node.

Arguments: ScrollViewConceptMetadata.ScrollUpMessageArguments

ScrollViewConceptMetadata.ScrollDownMessage

Sets the scroll delta to one step down and starts scrolling in that direction. Use this action to scroll a Scroll View or Grid List Box node.

Arguments: ScrollViewConceptMetadata.ScrollDownMessageArguments

ScrollViewConceptMetadata.ScrollLeftMessage

Sets the scroll delta to one step left and starts scrolling in that direction. Use this action to scroll a Scroll View or Grid List Box node.

Arguments: ScrollViewConceptMetadata.ScrollLeftMessageArguments

ScrollViewConceptMetadata.ScrollRightMessage

Sets the scroll delta to one step right and starts scrolling in that direction. Use this action to scroll a Scroll View or Grid List Box node.

Arguments: ScrollViewConceptMetadata.ScrollRightMessageArguments

ScrollViewConceptMetadata.ScrollHomeMessage

Sets the scroll delta to home and starts scrolling in that direction. Use this action to scroll a Scroll View or Grid List Box node.

Arguments: ScrollViewConceptMetadata.ScrollHomeMessageArguments

ScrollViewConceptMetadata.ScrollEndMessage

Sets the scroll delta to end and starts scrolling in that direction. Use this action to scroll a Scroll View or Grid List Box node.

Arguments: ScrollViewConceptMetadata.ScrollEndMessageArguments

ScrollViewConceptMetadata.ScrollPageUpMessage

Sets the scroll delta to one page up and starts scrolling in that direction. Use this action to scroll a Scroll View or Grid List Box node.

Arguments: ScrollViewConceptMetadata.ScrollPageUpMessageArguments

ScrollViewConceptMetadata.ScrollPageDownMessage

Sets the scroll delta to one page down and starts scrolling in that direction. Use this action to scroll a Scroll View or Grid List Box node.

Arguments: ScrollViewConceptMetadata.ScrollPageDownMessageArguments

Message Arguments

Message arguments classes define message arguments used for different message types. Each class defines a number of property types - arguments - together with getter and setter functions for them.

ScrollViewConceptMetadata.ScrollDirectionMessageArguments

ScrollDirectionProperty

Sets the scrolling direction for a Scroll View node.

Example
local value = arguments:getScrollDirectionProperty()
arguments:setScrollDirectionProperty(value)

ScrollViewConceptMetadata.ScrollDownMessageArguments

ScrollViewConceptMetadata.ScrollEdgeMessageArguments

ScrollEdgeProperty

Set the direction in which a Scroll View node scrolls when you instruct it to scroll to either of the edges.

Example
local value = arguments:getScrollEdgeProperty()
arguments:setScrollEdgeProperty(value)

ScrollViewConceptMetadata.ScrollEndMessageArguments

ScrollViewConceptMetadata.ScrollFinishedMessageArguments

ScrollViewConceptMetadata.ScrollHomeMessageArguments

ScrollViewConceptMetadata.ScrollLeftMessageArguments

ScrollViewConceptMetadata.ScrollMessageArguments

ScrollPositionXProperty

Sets the x axis coordinate for the new scroll position of a Scroll View node.

Example
local value = arguments:getScrollPositionXProperty()
arguments:setScrollPositionXProperty(value)
ScrollPositionYProperty

Sets the y axis coordinate for the new scroll position of a Scroll View node.

Example
local value = arguments:getScrollPositionYProperty()
arguments:setScrollPositionYProperty(value)
ScrollSpeedProperty

Sets the scrolling speed of a Scroll View node.

Example
local value = arguments:getScrollSpeedProperty()
arguments:setScrollSpeedProperty(value)

ScrollViewConceptMetadata.ScrollPageDownMessageArguments

ScrollViewConceptMetadata.ScrollPageMessageArguments

ScrollPageProperty

Sets the direction in which a Scroll View node scrolls when you instruct it to scroll by the layout height of that Scroll View node.

Example
local value = arguments:getScrollPageProperty()
arguments:setScrollPageProperty(value)

ScrollViewConceptMetadata.ScrollPageUpMessageArguments

ScrollViewConceptMetadata.ScrollPositionMessageArguments

ScrollPositionProperty

Sets the x and y axis coordinates for the new scroll position of a Scroll View node.

Example
local value = arguments:getScrollPositionProperty()
arguments:setScrollPositionProperty(value)

ScrollViewConceptMetadata.ScrollRightMessageArguments

ScrollViewConceptMetadata.ScrollStartedMessageArguments

ScrollViewConceptMetadata.ScrollTargetMessageArguments

ScrollTargetProperty

Sets the target position for a Scroll View node.

Example
local value = arguments:getScrollTargetProperty()
arguments:setScrollTargetProperty(value)

ScrollViewConceptMetadata.ScrollUpMessageArguments

ScrollViewConceptMetadata.ScrolledMessageArguments

ScrollViewConceptMetadata.SetScrollMessageArguments

ScrollViewConceptMetadata.SetScrollTargetMessageArguments

ScrollViewConceptMetadata.SnapMessageArguments

SnapPositionProperty

Sets the target of a snap request.

Example
local value = arguments:getSnapPositionProperty()
arguments:setSnapPositionProperty(value)
SnapDirectionProperty

Sets the direction of a snap request.

Example
local value = arguments:getSnapDirectionProperty()
arguments:setSnapDirectionProperty(value)

ScrollViewConceptMetadata.SnapRequestMessageArguments

ScrollViewConceptMetadata.UserScrollFinishedMessageArguments

ScrollViewConceptMetadata.UserScrollStartedMessageArguments

ScrollViewConceptMetadata.ZoomedMessageArguments

ZoomProperty

Sets the zoom level for a Scroll View node.

Example
local value = arguments:getZoomProperty()
arguments:setZoomProperty(value)