OBJECT Get vertical alignment
OBJECT Get vertical alignment ( {* ;} object ) : Integer
| Parameter | Type | Description | |
|---|---|---|---|
| * | Operator | → | If specified, object is an object name (string)If omitted, object is a variable |
| object | any | → | Object Name (if * is specified) or Variable (if * is omitted) |
| Function result | Integer | ← | Type of alignment |
This command is not thread-safe, it cannot be used in preemptive code.
Description
The OBJECT Get vertical alignment command returns a value indicating the type of vertical alignment applied to the object designated by the object and * parameters.
If you pass the optional * parameter, this indicates that the object parameter is an object name (a string). If you do not pass this parameter, this indicates that the object is a variable. In this case, you pass a variable reference instead of a string.
Note: If you apply this command to a set of objects, only the alignment value for the last object is returned.
The value returned corresponds to one of the following constants, found in the Form Objects (Properties) theme:
| Constant | Type | Value |
|---|---|---|
| Align bottom | Integer | 4 |
| Align center | Integer | 3 |
| Align top | Integer | 2 |
Vertical alignment can be applied to the following types of form objects:
- list boxes,
- list box columns,
- list box headers and footers.
See also
OBJECT Get horizontal alignment
OBJECT SET HORIZONTAL ALIGNMENT
OBJECT SET VERTICAL ALIGNMENT