Edit control events

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 / Edit control

Default events
Events supported by WINDEV and WINDEV Mobile
Events supported in WEBDEV
Optional events
"Validate with the keyboard" event
"Select a value in the list of input suggestions" event

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

Edit control events

Default events

Events supported by WINDEV and WINDEV Mobile

The following events appear by default in the WINDEV and WINDEV Mobile code editor:

Event	Runtime condition

Initialization	Executed when the window is opened. *
Enter	Executed when the input cursor enters the control.
Exit	Executed when moving from one control to another (TAB key, selecting another control with the mouse, etc.).
Add a token	This event is only available for "Text token" Edit controls. Executed each time the user adds a token in the control. The token is added when a character specified as a token separator is used. This event receives a variable of type Token as parameter, which allows handling the token that has been added. If this event returns: True, the token is added in the Edit control, False, the token is not added. The input area of the control is cleared. This event is not executed if the addition is done programmatically.
Delete a token	This event is only available for "Text token" Edit controls. Executed when the user deletes a token by clicking the "X" icon. This event receives a variable of type Token as parameter, which allows handling the deleted token. If this event returns: True, the token is deleted from the Edit control, False, the token is not deleted from the Edit control. This event is not executed if an element is deleted programmatically.
Click a token	This event is only available for "Text token" Edit controls. Executed when a token in an Edit control is clicked. This event receives a variable of type Token as a parameter, which can be used to manipulate the token clicked.
Enter input mode in a token	This event is only available for "Text token" Edit controls. Executed when the "Edit" option is selected in the context menu of the token. This event receives a variable of type Token as a parameter, which can be used to manipulate the token clicked. If this event returns: True, the token in the Edit control changes to input mode, False, the token doesn't change to input mode.
Modify a token	This event is only available for "Text token" Edit controls. Executed when the entry in the token is confirmed. This event receives a variable of type Token as a parameter, which can be used to manipulate the token clicked. If this event returns: True, the token text is modified, False, the token text is not modified.
Whenever modifying	Executed whenever the content of the control is modified (entering or deleting a character, for example). This event is also executed when a token is dragged and dropped in a "Text token" Edit control.

(*) 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:

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.

Events supported in WEBDEV

The following events appear by default in the WEBDEV code editor:

Event	Runtime condition

Initialization (Server code)	Executed when the page is opened.
Enter (Browser code)	Executed when the control gains focus.
Whenever modifying (Browser code)	Executed each time the content of the control changes (when a character is entered or removed, for example). This makes it possible to check the input or show suggestions as the user types, without returning to the server.
Leave after changes (Browser code)	Executed when moving from one control to another (selecting another control with the mouse, etc.) after the content of the control was modified (entering or deleting a letter, for example).
Exit (Browser code)	Executed when moving from one control to another (selecting another control with the mouse, etc.).
Add a token (Browser code)	This event is only available for "Text token" Edit controls. Executed each time the user adds a token in the control. The token is added when a character specified as a token separator is used. If this event returns: True, the token is added in the Edit control, False, the token is not added. The input area of the control is cleared. This event is not executed if the addition is done programmatically.
Click a token (Browser code)	This event is only available for "Text token" Edit controls. Executed when a token in an Edit control is clicked.
Delete a token (Browser code)	This event is only available for "Text token" Edit controls. Executed when the user deletes a token by clicking the "X" icon. If this event returns: True, the token is deleted from the Edit control, False, the token is not deleted from the Edit control. This event is not executed if the deletion was done programmatically.

Note: In a static page, only browser codes are available.

Optional events

Several optional events can be added. 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..

For example, you can use the following events:

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

"Validate with the keyboard" event

The optional "Validate with the keyboard" event will be executed when the button at the bottom right of the alphabetical keyboard is used.

To configure this button:

Go to the "Details" tab of the Edit control description window.
Go to "Keyboard button" and select the desired type of button. Depending on the selected type, the system will display the corresponding button in the current language on the device.
Confirm.
Open the code of the Edit control.
If necessary, add the "Validate with the keyboard" optional event and write the code of the desired action.

"Select a value in the list of input suggestions" event

The optional "Select a value in the list of input suggestions" event is executed when the user selects an element from the list of input suggestions. To handle this event more easily, it is associated with a procedure:

PROCEDURE InputSuggestionSelection(MySelection is AssistedInput)

The variable of type AssistedInput contains the characteristics of the element selected in the input suggestions (text displayed and corresponding stored value).

For example, this event allows you to:

get the selected option.
change the value displayed in the Edit control after the selection is made.

// Add a suggestion
_AutocompleteSuggestion is AssistedInput
_AutocompleteSuggestion.Caption = "Alpharetta, GA 30022"
_AutocompleteSuggestion.StoredValue = 30022
AssistedInputAdd(EDT_PostalCode, _AutocompleteSuggestion)

// -- Event "Select a value in the list of input suggestions"
PROCEDURE Selection(MySelection is AssistedInput)
EDT_PostalCode = MySelection.StoredValue