version 2004
DELETE LISTBOX ROW ({*; }object; position)
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) | |||
position | Longint | Position of the row to delete |
Description
The DELETE LISTBOX ROW command deletes the row number position (visible or not) from 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, 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 do not pass a string, but a variable reference. For more information about object names, refer to the Object Properties section.
Keep in mind that after command execution, there will no longer be any element selected in the list box.
The position row is automatically removed from all the arrays used by the list box columns.
If the position value is higher than the total number of rows in the list box, the command does nothing.
Note: This command does not take into account any hidden/displayed states of list box rows.
See Also
Get number of listbox rows, INSERT LISTBOX ROW.