scroll-position

Arguments: window-or-object

For a window

Returns the position to which window-or-object has been scrolled relative to the page top left. To scroll a window to a new position, call scroll-to or scroll.

For other objects

scroll-position may also be called on a grid-section, where the returned value is an integer rather than a position object. For a grid-row-section the value is a vertical scroll distance, and for a grid-column-section it is a horizontal scroll distance.

The scroll-position of a chart-widget is also a non-negative integer rather than a position object, since a chart will scroll only along its item-axis. The default value is zero, with the earliest chart data in view. (setf scroll-position) may be called to scroll a chart-widget to a particular place programmatically; passing a value of :end will scroll the widget to the very end of its data. See also scrolled-to-end and scrolled-to-end-maintained.

See also nscroll-position.

Copyright (c) 1998-2022, Franz Inc. Lafayette, CA., USA. All rights reserved.
This page was not revised from the 10.0 page.
Created 2019.8.20.