LISTBOX Get row height
LISTBOX Get row height ( {* ;} object ; row ) : 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) |
| row | Integer | → | List box row whose height you want to get |
| Function result | Integer | ← | Row height |
This command is not thread-safe, it cannot be used in preemptive code.
Description
The LISTBOX Get row height command returns the current height of the specified row in the list box object designated using the object and * parameters. Row height can be set globally using the Property List or the LISTBOX SET ROWS HEIGHT command, or individually by means of the LISTBOX SET ROW HEIGHT command.
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.
If the specified row does not exist in the list box, the command returns 0 (zero).
The returned height value is expressed:
- in the current unit defined globally for the list box rows either in the Property list or by a prior call to the LISTBOX SET ROWS HEIGHT command when the row height is fixed,
- in pixels when the row height is variable, i.e. set to automatic (see Automatic Row Height) or handled by an array.
See also
LISTBOX Get auto row height
LISTBOX Get rows height
LISTBOX SET ROW HEIGHT