Events associated with Looper controls

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

Editors

Controls (window/page/report)

Controls

Looper control

Events associated with Looper controls

Events managed by default

Filtering the records (browsing looper only)

Click on a Looper control (browser code only)

Optional events

See also

Events associated with Looper controls

Events managed by default

Events managed by WINDEV and WINDEV Mobile

WINDEV and WINDEV Mobile manage the following events by default (order of appearance in the code editor):

Event	Runtime condition

Initializing	Run when opening the window.* Special case: browsing Looper control filled automatically: When this code is run, the Looper control is not filled yet. To force the Looper control to be filled in this code, use: LooperDisplay the properties for managing the browsing Table controls: BrowsedFile, BrowsedItem or Filter properties. You also have the ability to filter the records with HFilter.
End of initialization	Event only for browsing Looper controls filled automatically: Run once the Looper control has been filled. This code can be used to add or modify an element of the Looper control.
Entry in the Looper control	Run when one of the Looper controls takes focus.
Exit from the Looper control	Run when moving from one control to another (TAB key, selecting another control with the mouse, etc.).
Whenever a Looper control is modified	Run when the user modifies the content of the Looper control. This event is not run.
Entry in edit in a row of the Looper control	Run when the user selects a row to enter data. This event is not run.
Exit from a row of the Looper control	Run when moving from one row or control to another (TAB key, selecting another control with the mouse, etc.). This event is not run.
Displaying a row of the Looper control	Run when a new row must be displayed in the Looper control: redisplaying the Looper control, etc. This event is not run. This event is not available in browsing Looper controls for performance reasons.
Selecting a row of the Looper control	Run when the user selects a row (without input).
Versions 20 and later Pull to refresh New in version 20 Pull to refresh Pull to refresh	This event is automatically added when the "Pull to refresh" feature is enabled ("Details" tab in the description window of Looper control). This event is run when a refresh gesture is detected on the Looper control. Once this event has been run, the refresh bar will be automatically hidden except if LooperRefreshVisible is called. For more details, see Pull to Refresh on Table and Looper controls (Android/iOS).
Versions 18 and later Before automatically deleting a row by swipe New in version 18 Before automatically deleting a row by swipe Before automatically deleting a row by swipe	Event only available if an automatic deletion on row swipe has been defined ("Details" tab of the control description) Run before the automatic deletion of record displayed in the row. This event is used to run different tests for example. If this event returns False the deletion is not performed. See Moves and gestures in a Looper control for more details.
Versions 18 and later After automatic deletion of a row by swipe New in version 18 After automatic deletion of a row by swipe After automatic deletion of a row by swipe	Event only available if an automatic deletion on row swipe has been defined ("Details" tab of the control description) Run after the effective deletion of the record. This event is used, for example, to re-display the data. For more details, see Moves and gestures in a Looper control.
Versions 18 and later Row swipe New in version 18 Row swipe Row swipe	Event only available if an action on row swipe has been defined ("Details" tab of the control description) Case of automatic deletion: This event is executed BEFORE the event "Before deleting a row". If this event returns False, the event "Before automatically deleting a row" is not run and the record is not deleted. Case of action by programming: This event is run when the user swipes the row. This event allows you to program the desired action. See Moves and gestures in a Looper control for more details.
Versions 18 and later Beginning of source Drag/Drop New in version 18 Beginning of source Drag/Drop Beginning of source Drag/Drop	Run at the beginning of Drag/Drop for the element. This event is used to run different tests for example. If this event returns False the movement is not performed.
Versions 18 and later Drop in target Drag/Drop New in version 18 Drop in target Drag/Drop Drop in target Drag/Drop	Run when the user finishes the element Drag/Drop. If this event returns False the movement is not performed.
Filtering records	Optional code for browsing Looper controls filled automatically: Run just before displaying a row. This event filters the records displayed in the Looper control. This event is detailed at the end of this page. This event is not available.

(*) By default, the "Initializing" event of each control is run according to the order in which the controls were created in the window. To modify this order of execution:

On the "Window" pane, in the "Order" group, click "Initialization".
In the window displayed, use the arrows on the right to modify the order in which the controls are initialized.

Events managed by WEBDEV

WEBDEV manages the following events by default (order of appearance in the code editor):

Event	Runtime condition

Initialization (Server code)	Run when the page is opened. Special case: Browsing looper automatically filled: When this code is run, the Looper control is not filled yet. To force the Looper control to be filled in this code, use: or the LooperDisplay function the properties for managing browsing Looper controls: BrowsedFile, BrowsedItem or Filter.
End of initialization (Server code)	Code for browsing Looper controls filled automatically: Run once the Looper control has been filled. This code can be used to add or modify an element of the Looper control.
Row display (Server code)	Run when a new row must be displayed in the Looper control: redisplaying the Looper control, etc Used to manage calculated attributes.
Filtering the records (Server code)	Code for browsing Looper controls filled automatically: Run just before displaying a row. This event filters the records displayed in the Looper control. This event is detailed at the end of this page.

Remark: In a static page, only optional events are available.

Filtering the records (browsing looper only)

The event "Filtering the records" is run right after a row of the Looper control is displayed. Therefore, it is run:

when initializing the Looper control.
whenever a row is displayed in the Looper control.

This event filters the records displayed in the Looper control.

To implement a filter, the event "Filtering the records" must return a value:

True to specify that the record matches to the filter and that it must be displayed.
False to specify that the record does not match the filter and that it must not be displayed.
Cancel to stop reading the data source of the Looper control (very rare case).

Example:

// -- Filter records --
// Displays the customers who placed orders exceeding 3000 Euros
IF Order.TotalIOT >= 3000 THEN
RESULT True
ELSE
RESULT False
END

In this code, the data handled affects the record currently read by the Looper control. This data comes from the data file or query linked to the Looper control.

Remark: In WINDEV and WINDEV Mobile, the event "Recording the records" is an optional event. In WEBDEV, this event is proposed by default.

Click on a Looper control (browser code only)

The event "Click on the Looper control" is run when the user clicks on a row of the Looper control.

Versions 17 and later
This process is used to select the row. This event returns the values of the attributes corresponding to the row. For example, the following click code is used to find out the value of the ATT_Title attribute for the row that was clicked:

Trace(ATT_Title)

New in version 17
This process is used to select the row. This event returns the values of the attributes corresponding to the row. For example, the following click code is used to find out the value of the ATT_Title attribute for the row that was clicked:

Trace(ATT_Title)

This process is used to select the row. This event returns the values of the attributes corresponding to the row. For example, the following click code is used to find out the value of the ATT_Title attribute for the row that was clicked:

Trace(ATT_Title)

Optional events

Several optional events can be managed. To add an optional event:

Select the requested control.
Display the code window of this control (F2 key).
Click the link "Add other events to xxx" at the bottom of the window code, after the last event.
All the optional events available for the control are displayed.
Check the optional event to add and validate.
Remark: You can select several optional events.
The selected optional event is automatically added to the events managed by the control.

To disable an optional event, simply perform the same operations to display the list of optional events. Then simply uncheck the optional events to delete.
Remark: If the disabled code contains WLanguage code, this code is automatically deleted.

You can manage, for example:

left mouse button down, up, with a double click,
right button down, up, etc.

See the Optional events for more details.