LISTBOX INSERT ROWS
LISTBOX INSERT ROWS ( {* ;} object ; rowPosition {; numRows} )
| 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) |
| rowPosition | Integer | → | Position of the row to insert |
| numRows | Integer | → | Number of rows to insert |
This command is not thread-safe, it cannot be used in preemptive code.
Description
The LISTBOX INSERT ROWS command inserts one or several new row(s) in the list box set in the object and * parameters.
Note: This command only works with list boxes based on arrays. When this command is used with a list box based on a selection of records/entities or a collection, it does nothing and the OK system variable is set to 0.
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 pass a variable reference instead of a string. For more information about object names, refer to the Object Properties section.
By default, if numRows is omitted, only one row is inserted. Otherwise, the command inserts the number of rows defined in this parameter.
This command inserts the row(s) at the position set by the rowPosition parameter and these row(s) are automatically added at this position in all the arrays used by the list box columns, whatever their type and their visibility.
If the rowPosition value is higher than the total number of rows in the list box, the command adds the row(s) at the end of each array. If it is equal to 0, the command adds the row(s) at the beginning of each array. If it contains a negative value, the command does nothing.