Grid: Clear

See also: Grid: Fill, Grid: Add row(s), Grid: Remove row

Actions – Abstract

The action Grid: Clear removes all rows from a Data grid or one of the other List elements linked as a Target element, as far as permissible, according to the data service configuration for the target element.

images/download/attachments/189433950/image-2024-10-10_15-9-46-version-1-modificationdate-1728565786453-api-v2.png

The action Grid: Clear removes all rows from a Data grid or one of the other List elements linked as a Target element, as far as permissible, according to the data service configuration for the target element.

An existing selection within the target element is also cleared in addition to the ‘rows’ of the target element.

'Specific notes' (see below) should be considered for details.

►IMPORTANT◄ A target element from the group List elements must be linked to make this action appear as a choice for Action type.

Specific notes for different types of List elements

Relevance for

Notes

Data grid

Auswahlfeld
/Combobox

Multiselect combobox

Tree element

If the service configuration of the target element specifies a Data object service, Grid: Clear will be ineffective at runtime, provided that service is still relevant and has not been replaced, e.g. by the action Grid: Fill.

  • never

  • possible

  • possible

  • possible

List elements for which a selection represents the value of the element, assume given values as a selection after Grid: Clear, even though these values are not featured in the list. Whether, or how, such a phantom selection is visible for users, depends on the type and configuration details of the list element.

If a list element with a phantom selection is later re-populated – e.g. by Grid: Fill – with rows matching the values of the phantom selection, these appear selected automatically.

Such potentially confusing effects may be prevented by executing the action Grid: Clear combined with Set value to define a value of 'Nothing' ($null) for the list element.

  • never

  • possible

A 'cleared' Combobox with the view type 'Options' may appear as follows:

images/download/attachments/189433950/image2020-4-23_19-55-53-version-1-modificationdate-1728565596770-api-v2.png

Due to the lack of list data, the value (e.g. an ID) cannot be interpreted by a label expression, which therefore returns only two literal characters '( )'.

  • possible

A cleared Multiselect combobox with the view type 'Default' might appear like this:

images/download/attachments/189433950/image2020-4-23_19-53-38-version-1-modificationdate-1728565596767-api-v2.png

Here the default label indicates the (internal) value for each selected item.

  • possible

A cleared tree will always appear empty, even if items were selected or marked beforehand.

A phantom selection or marking will be applied to elements added, when the tree is (re-)populated with 'rows' resembling matching values.

Example

This action can, for example, be used to clear a Data grid when a Button is clicked.