LayoutGetScrollOffsetY

Syntax

OffsetY.d = LayoutGetScrollOffsetY(Layout)

Description

Retrieves the current vertical scroll offset of the specified layout container in device-independent pixels (DIPs). A positive offset means the content has been scrolled upwards.

Parameters

Layout
The handle of the layout object whose scroll offset is to be retrieved. If #Null, it attempts to use the current layout.

Return Value

Returns the vertical scroll offset as a floating-point number (Double). Returns 0.0 if the layout handle is invalid or if there is no vertical scrolling.

Remarks

This value represents how far the layout's content has been scrolled vertically. It's managed internally by ProGUI when the layout's content height (overflow height) exceeds its container height and scrollbars are active. This function reads the current state; it doesn't set the scroll position.

See Also

LayoutGetScrollOffsetX

Supported OS

Windows, Linux