4D v16.3
LISTBOX Get row color
- 4D Language Reference
-
- List Box
-
- Managing List Box Objects
- Managing Hierarchical List Boxes
- Using object arrays in columns (4D View Pro)
- 4D View Pro
- LISTBOX COLLAPSE
- LISTBOX DELETE COLUMN
- LISTBOX DELETE ROWS
- LISTBOX DUPLICATE COLUMN
- LISTBOX EXPAND
- LISTBOX Get arrayUpd
- LISTBOX GET ARRAYS
- LISTBOX GET CELL COORDINATES
- LISTBOX GET CELL POSITION
- LISTBOX Get column formula
- LISTBOX Get column width
- LISTBOX Get footer calculation
- LISTBOX Get footers height
- LISTBOX GET GRID
- LISTBOX GET GRID COLORS
- LISTBOX Get headers height
- LISTBOX GET HIERARCHY
- LISTBOX Get information
- LISTBOX Get locked columns
- LISTBOX Get number of columns
- LISTBOX Get number of rows
- LISTBOX GET OBJECTS
- LISTBOX GET PRINT INFORMATION
- LISTBOX Get row color
- LISTBOX Get row font style
- LISTBOX Get row heightNew
- LISTBOX Get rows height
- LISTBOX Get static columns
- LISTBOX GET TABLE SOURCE
- LISTBOX INSERT COLUMN
- LISTBOX INSERT COLUMN FORMULA
- LISTBOX INSERT ROWS
- LISTBOX MOVE COLUMN
- LISTBOX MOVED COLUMN NUMBER
- LISTBOX MOVED ROW NUMBER
- LISTBOX SELECT BREAK
- LISTBOX SELECT ROW
- LISTBOX SET ARRAYUpd
- LISTBOX SET COLUMN FORMULA
- LISTBOX SET COLUMN WIDTH
- LISTBOX SET FOOTER CALCULATION
- LISTBOX SET FOOTERS HEIGHT
- LISTBOX SET GRID
- LISTBOX SET GRID COLOR
- LISTBOX SET HEADERS HEIGHT
- LISTBOX SET HIERARCHY
- LISTBOX SET LOCKED COLUMNS
- LISTBOX SET ROW COLOR
- LISTBOX SET ROW FONT STYLE
- LISTBOX SET ROW HEIGHTNew
- LISTBOX SET ROWS HEIGHT
- LISTBOX SET STATIC COLUMNS
- LISTBOX SET TABLE SOURCE
- LISTBOX SORT COLUMNS
LISTBOX Get row color
| LISTBOX Get row color ( {* ;} object ; row {; colorType} ) -> Function result | ||||||||
| Parameter | Type | Description | ||||||
| * | Operator |
|
If specified, object is an object name (string) If omitted, object is a variable | |||||
| object | Form object |
|
Object name (if * is specified) or Variable (if * is omitted) |
|||||
| row | Longint |
|
Row number | |||||
| colorType | Longint |
|
Listbox font color (default) or Listbox background color | |||||
| Function result | Longint |
|
Color value | |||||
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.
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/shown 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.
Given the following list box:
vColor:=LISTBOX Get row color(*;"Col5";3)
vColor2:=LISTBOX Get row color(*;"List Box";3)
vColor3:=LISTBOX Get row color(*;"List Box";lk background color)
// vColor contains 0xFFFF00 (yellow)
// vColor2 contains 0x00FF (blue)
// vColor3 contains 0x00FF0000 (red)
Product: 4D
Theme: List Box
Number:
1271
Created: 4D v14
4D Language Reference ( 4D v16)
4D Language Reference ( 4D v16.1)
4D Language Reference ( 4D v16.2)
4D Language Reference ( 4D v16.3)
