Events associated with Table controls

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help / Developing an application or website / Controls, windows and pages / Controls: Available types / Table control

Default events
Optional events
Filter records (Table based on a data file only)
Before displaying the automatic tooltip of scrollbar

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

Events associated with Table controls

Default events

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

Event	Runtime condition

Initialization	Executed when the window is opened. () Special case: Table control based on a data file filled automatically* When this code is run, the Table control is not filled yet. To force the Table control to be filled in this code, use: the TableDisplay function, the Table control based on a data file management properties: BrowsedFile, BrowsedItem or Filter. You can also filter records with HFilter.
End of initialization	Code only for automatically populated Table controls based on a data file: Executed after the Table control has been populated. This code is used to select an element in the Table control, to add or modify an element.
Entry in the Table control	Executed when the control gains focus.
Exit the Table control	Executed when moving from one control to another (TAB key, selecting another control with the mouse, etc.).
Entry in edit in a row of the Table control	Run when the user selects a row to perform an input in this row.
Exit a row of the Table control	Run when moving from one row or control to another (TAB key, selecting another control with the mouse, etc.). The Table control must be in edit. In this code, the current row corresponds to the row that was selected beforehand. Caution: Table control with Check Box column: simply modifying the check box does not run the row exit code. If a user clicks a check box column, WINDEV does not consider this as entering the row in edit mode . The "Entry in input in a row" and "Exit a row" events are not executed. To manage this case, it is recommended to use the column modification code. Read-only Table control: this code is not executed when moving to another row in a read-only Table control. In this code, the current row corresponds to the new selected row.
Displaying a row of the Table control	Run when a new row must be displayed in the Table control: redisplaying the Table control, scrolling or moving in the Table control, etc, ... This event is also run when column is assigned. If several columns are assigned through programming, the display code will be run several times. Tip: To modify several columns, use TableModifyLine rather than the direct assignment. This event is not available in Table controls based on a data file for performance reasons.
Selecting a row of the Table control	Run when the user selects a row (without input). This event is also run when the user clicks a cell whose selection mode is set to "Single selection" or: Multi-selection".
Pull to refresh	This event is automatically added when the "Pull to refresh" feature is enabled ("Details" tab in the description window of the Table control). This event is run when a refresh gesture is detected on the Table control. At the end of this event, the refresh bar will be automatically hidden except if TableRefreshVisible has been called. For more details, see Pull to Refresh on Table and Looper controls (Android/iOS).
Filter records (optional event)	Code only for automatically populated Table controls based on a data file: Run just before displaying a row. This event filters the records displayed in the Table control. This event is detailed at the end of this page.
Drag and Drop management events (optional events)	Code only for Table controls populated programmatically and Table controls based on a variable: These events are used to simplify the management of programmed Drag and Drops. The available events are: Start drag-and-drop operation. End drag-and-drop operation. Enter drop target. Drag over drop target. Drop on drop target. Leave drop target. Remark: If one of these events contains some code, the Drag and Drop feature is not automatically managed for Table controls: the Drag and Drop in the Table control must be managed through programming
Scrolling events (optional events)	These events make it easy to manage the vertical scrollbar in the control. The available events are: Start scrolling: Executed when the vertical scrollbar of the control starts moving. While scrolling: Executed while the vertical scrollbar of the control moves. Stop scrolling: Executed when the vertical scrollbar of the control stops moving. Remark: ScrollbarPosition gets the position of the scrollbar.

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

On the "Window" tab, in the "Order" group, click "Initialization".
In the window that appears, use the arrows on the right to change the order in which the controls are initialized.

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

Event	Runtime condition

Initializing (Server code)	Executed when the page is opened. Special case: Table control based on a data file filled automatically: When this code is run, the Table control is not filled yet. To force the control to be populated in this event, use: the TableDisplay function, the Table control based on a data file management properties: BrowsedFile, BrowsedItem or Filter. You can also filter records with HFilter.
End of initialization (Server code)	Code only for automatically populated Table controls based on a data file: Executed after the Table control has been populated. This code is used to select an element in the Table control, to add or modify an element.
Row selection (Server code)	Code run when the user selects a row in the Table control.
Row selection (Browser code)	Table control in "Server + AJAX" mode Run when the user selects a row (without input). Table control in "Browser" mode Run when the user selects a row (without input)
Row display (Server code)	Run when a new row must be displayed in the Table control: redisplaying the Table control, scrolling or moving in the Table control, etc. Used to manage the calculated columns.
Row display (Browser code)	Table control in "Browser" mode only Run when a new row must be displayed in the Table control: redisplaying the Table control, scrolling or moving in the Table control, etc.
Table click (Browser code)	Run when the Web user selects a row.
Exit a row (Server code)	Table control in "Server + AJAX" mode only Run when moving from one row or control to another (TAB key, selecting another control with the mouse, etc.)
Filter records (Server code)	Code only for automatically populated Table controls based on a data file: Run just before displaying a row. This event filters the records displayed in the Table control. This event is detailed at the end of this page.

Optional events

Several optional events are supported. To add an optional event:

Select the desired 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.
Note: Several optional events can be selected.
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.
Note: If the deactivated code contains WLanguage code, this code is automatically deleted..

You can manage the following aspects, for example:

the mouse hover over the control,
left mouse button down, up, double click,
right mouse button down, up, double click,
mouse wheel, etc.

Remark: The optional events differ according to the environment (WINDEV, WEBDEV, WINDEV Mobile) and the development platform.

Filter records (Table based on a data file only)

The "Filter records" event is executed after a row of the Table control is displayed. Therefore, it is run:

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

This event filters the records displayed in the Table control.

To implement a filter, the "Filter records" event 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 table (very rare case).

Example:

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

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

If an automatic filter is applied on the Table control (TableEnableFilter or filter enabled by the user directly), the filter defined by the "Filter records" event is combined with the automatic filter.

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

Before displaying the automatic tooltip of scrollbar

In Windows, the tooltip for the scrollbar in a Table control is displayed when the user clicks the "box" of the vertical scrollbar.
This tooltip contains the following information by default:

Range of rows currently displayed in the Table control.
Total number of rows in the Table control.
Information about the element currently displayed in the first row of the Table control in the sorted column.

The event "Before displaying the automatic tooltip of the scrollbar" is run just before the tooltip is displayed. This allows displaying a specific text in the tooltip using the ToolTip property, for example.