LISTBOX Get rows height
LISTBOX Get rows height ( {* ;} object {; unit} ) : 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) |
| unit | Integer | → | Unit of height value: 0 or omitted = pixels, 1 = lines |
| Function result | Integer | ← | Row height |
This command is not thread-safe, it cannot be used in preemptive code.
Description
The LISTBOX Get rows height command returns the current row height for the list box object set using the object and * parameters.
If you pass the optional * parameter, you indicate that the object parameter is an object name (string). If you do not pass this parameter, you indicate that the object parameter is a variable. In this case, you pass a variable reference instead of a string. For more information about object names, refer to the Object Properties section.
By default, if you omit the unit parameter, the row height returned is expressed in pixels. To set another unit, in the unit parameter you can pass one of the following constants, found in the List Box theme:
| Constant | Type | Value | Comment |
|---|---|---|---|
| lk lines | Integer | 1 | Height is expressed as a number of lines. 4D calculates the height of a line according to the font. |
| lk pixels | Integer | 0 | Height is expressed as a number of pixels (default). |
Note: For more information about calculating the height of rows, refer to the Design Reference manual.
See also
LISTBOX Get auto row height
LISTBOX Get row height
LISTBOX SET ROWS HEIGHT