Queue scroll

Command groupFlag affectedReversibleExecute on clientPlatform(s)
EventsNONONOAll

Syntax

Queue scroll
 (
Left
|
Right
|
Up
|
Down
[,
Page
])
 
field-name (units)

Types

LeftScroll the field to the left
RightScroll the field to the right
UpScroll the field up
DownScroll the field down

Options

PageIf specified,scrolling occurs in pages,rather than the units corresponding to the up and down arrows on the scroll bar

Description

This command queues a "scroll" event in the specified scrollable field, that is, it simulates a mouse click or page key event on a scrollable field. With this command you can scroll a field up or down, left or right provided the appropriate scroll bar is available. You cannot use this command to scroll a window instance.

The field name parameter must be the name of a window field, not the name of the method associated with the field or the data name ($name, not $dataname). As an alternative to a simple name string, you can supply a notation string such as $cinst.$objs.name or even $cinst.$toolbars.toolbar.$objs.name where in the latter case the object is a toolbar control in the window toolbar that can accept the focus e.g. a combo box.

The Units parameter specifies the number of lines to scroll up or down in a vertical scroll bar for a field; one unit represents one line. For a horizontal scroll bar, the unit is approximately one character.

If the Page option is selected, the event simulates clicking above or below the "thumb" and is the same as using the Page up or Page down key.

Example

# scroll a list field by 5 lines

Queue scroll
 (
Down
)
 
myListField (5)