4D v16.3
LISTBOX Get array
- 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 array
| LISTBOX Get array ( {* ;} object ; arrType ) -> 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) |
|||||
| arrType | Longint |
|
Type of array | |||||
| Function result | Pointer |
|
Pointer to array associated with property | |||||
Note: This command only works with array type list boxes.
The LISTBOX Get array command returns a pointer to the arrType array of the list box or list box column designated by the object and * parameters.
Style, color, background color or row control arrays can be associated with array type list boxes or (except for row control arrays) with the columns of array type list boxes, using the Property list in Design mode or using the LISTBOX SET ARRAY command.
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.
In arrType, pass the type of array for the property you want to get. You can use one of the following constants, available in the "List Box" theme:
| Constant | Type | Value | Comment |
| lk background color array | Longint | 1 | |
| lk control array | Longint | 3 | |
| lk font color array | Longint | 0 | |
| lk row height array | Longint | 4 | (4D View Pro license required) |
| lk style array | Longint | 2 |
The command returns one of the following values:
- Nil if no array for the requested property is associated with the column or the list box.
- a pointer to the array of the requested property, defined by the user.
- a pointer to the array of the requested property, defined dynamically when calling the LISTBOX SET ROW COLOR or LISTBOX SET ROW FONT STYLE command.
Typical examples of use:
vPtr:=LISTBOX Get array(*;"MyLB";lk font color array)
// returns a pointer to the font color array
// associated with the "MyLB" list box
vPtr:=LISTBOX Get array(*;"Col4";lk style array)
// returns a pointer to the font style array
// associated with the columns of the "Col4" list box
Product: 4D
Theme: List Box
Number:
1278
Created: 4D v14
Modified: 4D v15 R4
Modified: 4D v16
4D Language Reference ( 4D v16)
4D Language Reference ( 4D v16.1)
4D Language Reference ( 4D v16.2)
4D Language Reference ( 4D v16.3)
