LISTBOX Get row color
LISTBOX Get row color ( {* ;} object ; row {; colorType} ) : Text
| 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 |
| colorType | Integer | → | List box font color (default) or list box background color |
| Function result | Text | ← | Color 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 color command returns the color of a row or a cell in the list box designated by the object and * parameters as a CSS string.
Note: If you want to get the color as a 4-byte longint format, you need to use the OBJECT SET RGB COLORS command. For more information on color formats, please refer to the OBJECT SET RGB COLORS command description.
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 color of the row.
- When object designates a list box column, the command returns the color of the cell.
In row, pass the number of the row whose color you want to get.
Note: The command does not take any hidden/visible states of the list box rows into account.
In the colorType parameter, you can pass either the lk background color or lk font color constant ("List Box" theme) in order to find out the background or font color for the row. If you omit this parameter, the font color is returned.
Warning: A color 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:
var $vtColor;$vtColor2;$vtColor3 : Text
$vtColor:=LISTBOX Get row color(*;"Col5";3)
$vtColor2:=LISTBOX Get row color(*;"List Box";3)
$vtColor3:=LISTBOX Get row color(*;"List Box";3;lk background color)
// $vtColor contains "#FFFF00" (yellow)
// $vtColor2 contains "#0000FF" (blue)
// $vtColor3 contains "#FF0000" (red)