OBJECT GET SCROLL POSITION
OBJECT GET SCROLL POSITION ( {* ;} object ; vPosition {; hPosition} )
| Parameter | Type | Description | |
|---|---|---|---|
| * | Operator | → | If specified, object is an object name (string) If omitted, object is a variable or a field |
| object | any | → | Object name (if * is specified) or Variable or field or table (if * is omitted) |
| vPosition | Integer | ← | Number of first line displayed or Vertical scrolling in pixels (pictures) |
| hPosition | Integer | ← | Number of first column displayed or Horizonal scrolling in pixels (pictures) |
This command is not thread-safe, it cannot be used in preemptive code.
Description
The OBJECT GET SCROLL POSITION returns, in the vPosition and hPosition parameters, information related to the position of the scroll bars of the form object designated by the * and object parameters.
If you pass the optional * parameter, you indicate that the object parameter is the name of an object of the subform, hierarchical list, scrollable area, list box or picture type (in this case, pass a string in object). If you do not pass this parameter, you indicate that the object parameter is a variable (ListRef of hierarchical list, picture or list box variable) or a field.
Note: With subform type objects, only the syntax using an * is supported.
If object designates a list type object (subform, list form, hierarchical list, scrollable area or list box), vPosition returns the number of the first line displayed in the object. hPosition (list box only) returns the number of the first column that is completely visible in the left part of the list box. With other types of objects, this parameter returns 0.
If object designates a picture (variable or field), vPosition returns the vertical movement and hPosition the horizontal movement of the picture. These values are expressed in pixels with respect to the origin of the picture in the local coordinate system.