|
|
|
|
|
|
|
|
|
|
|
version 11.2 (Modified)
GET LISTBOX ARRAYS ({*; }object; arrColNames; arrHeaderNames; arrColVars; arrHeaderVars; arrColsVisible; arrStyles)
| Parameter | Type | Description | |
| * |  | 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) | |||
| arrColNames | Array string |  | Column object names |
| arrHeaderNames | Array string | | Header object names |
| arrColVars | Array pointer | | Pointers to column variables or |
| Pointers to column fields or Nil | |||
| arrHeaderVars | Array pointer | | Pointers to header variables |
| arrColsVisible | Array Boolean | | Visibility of each column |
| arrStyles | Array pointer | | Pointers to arrays or |
| style, color and visibility variables or Nil |
Description
The GET LISTBOX ARRAYS command returns a set of synchronized arrays providing information on each column (visible or invisible) in the list box set in the object and * parameters.
If you pass the optional * parameter, you indicate that the object parameter is an object name (string). If you do not pass this parameter, you indicate that the object parameter is a variable. In this case, you do not pass a string, but a variable reference. For more information about object names, refer to the Object Properties section.
Once the command is executed:
• The arrColNames array contains the list of object names for each column in the list box.
• The arrHeaderNames array contains the list of object names for each column header in the list box.
• The arrColVars array contains, for an array type list box, pointers toward variables (arrays) associated with each column of the list box. For a selection type list box, arrColVars contains:
- For a column associated with a field, a pointer to the associated field,
- For a column associated with a variable, a pointer to the variable,
- For a column associated with an expression, a Nil pointer.
• The arrHeaderVars array contains pointers toward variables associated with each column header of the list box.
• The arrColsVisible array contains a Boolean value for each column, indicating whether the column is visible (True) or hidden (False) in the list box.
• The arrStyles array contains, for an array type list box, four pointers to four arrays that allow the applying of a specific style, font color, background color and a custom hidden state to each row of the list box. These arrays are associated with the list box in the Property List of the Design environment. If an array is not specified for the list box, the corresponding item in arrStyles will contain a Nil pointer.
For a selection type list box, arrStyles contains:
- For each configuration set via a variable, a pointer to the variable,
- For each configuration set via an expression, a Nil pointer.
See Also
|
|
|
|
|
|
|
|
|
|
|