LISTBOX Get row font style
LISTBOX Get row font style ( {* ;} 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 | → | Row number |
| Function result | Integer | ← | Style value |
This command is not thread-safe, it cannot be used in preemptive code.
Description
Note: This command only works with array type list boxes.
The LISTBOX Get row font style command returns the font style of a row or a cell in the list box designated by the object and * parameters.
Passing the optional * parameter indicates that the object parameter is an object name (string). If you do not pass this parameter, it indicates that the object parameter is a variable. In this case, you pass a variable reference instead of a string.
You can designate a list box or a list box column in the object parameter:
- When object designates a list box, the command returns the style of the row.
- When object designates a list box column, the command returns the style of the cell.
In row, pass the number of the row whose style you want to get.
Note: The command does not take any hidden/shown states of the list box rows into account.
Warning: a style assigned to a row is not necessarily displayed in every cell of the row (see example). If conflicting color values are set using properties for list boxes or list box columns, an order of priority is applied. For more information, refer to the Design Reference manual.
Example
Given the following list box:
vStyle:=LISTBOX Get row font style(*;"Col5";3)
vStyle2:=LISTBOX Get row font style(*;"List Box";3)
// vStyle contains 1 (Bold)
// vStyle2 contains 6 (Italic + Underline)