ui.Dialog.deleteAllRows
Deletes all rows from the specified list.
Syntax
deleteAllRows(
name STRING )- name is the name of the screen record, see Identifying screen-arrays in dialog methods.
Usage
The deleteAllRows() method
removes all the rows of a list driven by a DISPLAY ARRAY or INPUT
ARRAY. This is equivalent to a deleteRow() call,
but instead of deleting one particular row, it removes all rows of
the specified list.
This method must not be called in control
blocks such as BEFORE ROW, AFTER ROW, BEFORE
INSERT, AFTER INSERT, BEFORE
DELETE, AFTER DELETE, it is designed to
be used in an ON ACTION block.
After
the method is called, all rows are deleted from the program array,
and the getArrayLength() method will return zero.
The method takes the name of the screen-array as parameter.
If
the deleteAllRows() method is called during an INPUT
ARRAY, the dialog will automatically append a new temporary row if the
focus is in the list, to let the user enter new data. When using AUTO
APPEND = FALSE attribute, no temporary row will be created
and the current row register will be automatically changed to make
sure that it will not be greater than the total number of rows.
If the deleteAllRows() method is called during an INPUT ARRAY
or DISPLAY ARRAY that has the focus, the BEFORE ROW control
block will be executed if you delete the current row. This is required to reset the internal state
of the dialog.
If the list was decorated with cell attributes, the program array defining the attributes will be cleared. If multi-row selection is enabled, selection flags are cleared.