4D v16.3

LISTBOX DELETE ROWS

Home

 
4D v16.3
LISTBOX DELETE ROWS

LISTBOX DELETE ROWS 


 

LISTBOX DELETE ROWS ( {* ;} object ; rowPosition {; numRows} )  
Parameter Type   Description
Operator in If specified, object is an object name (string) If omitted, object is a variable
object  Form object in Object name (if * is specified) or Variable (if * is omitted)
rowPosition  Longint in Position of the row to delete
numRows  Longint in Number of rows to delete

The LISTBOX DELETE ROWS command deletes one or several row(s) starting at rowPosition row (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 pass a variable reference instead of a string. 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 rowPosition row is automatically removed from all the arrays used by the list box columns.

If the rowPosition value is higher than the total number of rows in the list box, or if it is less than 1, the command does nothing.

Note: This command does not take into account any hidden/displayed states of list box rows.



See also 

LISTBOX Get number of rows
LISTBOX INSERT ROWS

 
PROPERTIES 

Product: 4D
Theme: List Box
Number: 914

The OK variable is changed by the command

 
HISTORY 

Created: 4D 2004
Renamed: 4D v12
Modified: 4D v13
Renamed: 4D v13

 
ARTICLE USAGE

4D Language Reference ( 4D v16)
4D Language Reference ( 4D v16.1)
4D Language Reference ( 4D v16.2)
4D Language Reference ( 4D v16.3)