ui.Dialog.deleteAllRows

Deletes all rows from the specified list.

Syntax

deleteAllRows(
   name STRING )
  1. name is the name of the screen record, see Identifying screen-arrays in ui.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.

The deleteAllRows() method itself does not execute any control block. However, in an INPUT ARRAY that has the focus and uses the default AUTO APPEND behavior, removing all rows triggers the automatic creation of a temporary row, which executes the BEFORE ROW, BEFORE INSERT and BEFORE FIELD control blocks. With AUTO APPEND = FALSE, no control block is executed. In a DISPLAY ARRAY, no control block is executed.

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.