LISTBOX SET ARRAY
LISTBOX SET ARRAY ( {* ;} object ; arrType ; arrPtr )
| 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) |
| arrType | Integer | → | Type of array |
| arrPtr | Pointer | → | Array to associate with property |
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 SET ARRAY command associates an arrType array with the list box or list box column designated by the object and * parameters.
Note: Arrays of styles, colors, background colors or row controls can also be associated with array type list boxes using the Property list in the Design mode.
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 to associate with the list box or column. You can use one of the following constants, available in the "List Box" theme:
| Constant | Type | Value |
|---|---|---|
| lk background color array | Integer | 1 |
| lk control array | Integer | 3 |
| lk font color array | Integer | 0 |
| lk row height array | Integer | 4 |
| lk style array | Integer | 2 |
In the arrPtr parameter, you pass a pointer to the array to use to support the property type.
Example 1
You want to reuse the font color array of the 4th column for the 10th column:
// retrieve a pointer to the array for column 4
$Pointer:=LISTBOX Get array(*;"Col4";lk font color array)
// check that it exists
If(Not(Nil($Pointer)))
//transfer to column 10
LISTBOX SET ARRAY(*;"Col10";lk font color array;$Pointer)
End if
Example 2
You want to set a row height array for a list box:
LISTBOX SET ARRAY(*;"LB";lk row height array;->RowHeightArray)