Properties associated with HTML Display controls

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

This content has been translated automatically. Click here to view the French version.

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

Overview
Default events
Events supported by WINDEV and WINDEV Mobile
Optional events
Optional Event: Page loading error

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

The HTML Display control

Properties associated with HTML Display controls

Overview

WINDEV and WINDEV Mobile include different WLanguage events associated with HTML Display Controls.

Default events

Events supported by WINDEV and WINDEV Mobile

The following events appear by default in the code editor:

Event	Runtime condition

Initialization	Executed when the window is opened. *
Click on a link	Executed when a link is clicked in the HTML Display control. Only external links (to another page) trigger this event. Internal links (to an anchor in the same page, for example) do not trigger this event. This event accepts parameters: `PROCEDURE ClickLink(sURL is string, bInNewWindow is boolean, sDestination is string)` where <sURL> is an optional string that contains the URL of the link clicked in the HTML Display control. If this event returns False, the action associated with the link will not be performed. Caution: the code must not include processing that is too slow or allows the field to regain focus. In this case, the default action will still be performed. Remarks: The code in the "Click on link" event must not execute a blocking process (e.g. display a dialog box). This event is only available for Android 7.0 (Nougat) and higher. Reminder: To find out which Android system version the application is running on, use the SysAndroidVersion function. This event will not be called if the clicked link corresponds to an anchor link in the page. The event is called only when the user clicks the link. A "simulated" click from JavaScript code, for example, will not trigger the event. Code sample: // Open links with a new window as destination, // in another specific window of the application PROCEDURE ClickLink(sURL is string, bInNewWindow is boolean, sDestination is string) IF bInNewWindow THEN // Open another requested window: // opening process of the other window, // delayed so that the current process responds // before opening the new window OpenNewBrowser(sURL) RETURN False // Overrides default behavior ELSE RETURN True // Keeps default behavior END INTERNAL PROCEDURE DisplayNewBrowser(sURLParam) <delay=10ms> // Important: set even the smallest delay <COMPILE IF ConfigurationType = Android OR ConfigurationType = iOS> OpenMobileWindow(WIN_POPUP, sURLParam) <ELSE> OpenChild(WIN_POPUP. sURLParam) <END> END
Before loading HTML page	Executed before loading the HTML document in the HTML Display control. If the user navigates using links in the HTML Display control, this event is executed before each HTML document is loaded. This event accepts parameters: `PROCEDURE ChangePage(sURL is string, sDestination is string)` where <sURL> is an optional string that contains the URL of the page to be displayed. If this event returns False, the page will not load.
After loading HTML page	Executed after the HTML document has been loaded in the HTML Display control. If the user navigates using links in the HTML Display control, this event is executed after each HTML document has been loaded.
Load resources	Allows you to be notified and prevent application scripts or images from being loaded (for security purposes, for example). This event accepts parameters: `PROCEDURE LoadResources(sURL is string, nType is int)` where: <sURL> is a string that corresponds to the URL of the resource to be loaded. <nType> is a constant used to identify the type of resource to be downloaded: typehtmlResImage the resource to download is an image. typehtmlResScript type: the resource to download is a script. typehtmlResCss the resource to download is a CSS style. typehtmlResXMLHttpRequest The resource to be downloaded is an XML document generated in response to an HTTP request. typehtmlOther the resource to be downloaded is of an unknown type. If this event returns False, the resource will not be loaded.
Right click on a link	Executed when the user right-clicks a link (to open a context menu). This event has the following format: `PROCEDURE RightClickLink(sURL is string)` where <sURL> is a string that contains the URL of the link.

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

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,
mouse wheel, etc.

Optional Event: Page loading error

The "Error loading page" event is executed if an error is detected when loading a page in the control. This event gets the details of the error encountered:

PROCEDURE LoadError(sUrl is string, sError is string, nErrorCode is int)

where:

<sURL> is a string that corresponds to the URL of the resource to be loaded.
<sErreur> is a string containing the error message.
<nErrorCode> is an integer corresponding to the error code.