WLEvent.on()

Triggers the event when a beep is about to play.

Added in version 1.2.4

Added in version 2.0.1

Triggers the event after a connection has been established to the host. The event object passed to "Connect" is empty.

When a scripting scope is entered. Fires after the scope is added to the scope stack, but before executing all functions registered for the scope.

When a scripting scope has exited.

Triggers the event when a general purpose key handler is registered. All software and hardware presses will be sent for this event.

Added in version 2.1.31

Triggers when the native screen is clicked or tapped. If the option Tap to Move Cursor is not enabled for the profile, this event is triggered, but the default action will be to discard the event.

Added in 2.1.23

Triggers the event when an NDEF NFC tag is scanned.

Starting in version 2.1.25, the API NFC.startCapture() must be used before NDEF events are dispatched.

Main event object

ndefRecord object

Example of emulating a scan from URI or text NFC tag

/*
This examples gets the first NDEF record, and checks first checks if the uri field is populated then sends a fakescan using the uri field. If the uri doesn't exist it tries the text field.
*/
NFC.startCapture();
WLEvent.on("Ndef",function(event){
    if(event.ndefRecords[0].type === "uri"){
        Device.fakeScan("nfc", event.ndefRecords[0].uri);
    }else if(event.ndefRecords[0].type === "text"){
        Device.fakeScan("nfc", event.ndefRecords[0].text);
    }
});

Example of enumerating the records

/*
This examples enumerates multiple records emulating a scan.
*/
WLEvent.on("Ndef",function(event){
    for(var i = 0; i<event.ndefRecords.length> ; i++){
        if(event.ndefRecords[i].type === "text"){
            Device.fakeScan("nfc", event.ndefRecords[i].text);
        }
    }
});

When a registered key is pressed on either the software or hardware keyboard. This event takes precedence over the general-purpose Key event. The values entered in place of “HHHH” must be a valid hex code. For example: OnKey<000D>.

Triggers the event when a screen is ready to be parsed. The functions in the event object can then be used to modify how the screen will be predicted. For an example of using the ParseScreen event, see Rapid modernization.

Added in version 2.0.0

Properties for containers returned by createTable(), createFooter(), or createSpanGroup().

Properties for element formatting

After an element is created, it may be styled using the following methods. Styling is applied in a manner consistent with the screen editor.

Added in version 2.1.1

Example of element formatting

ModernScreen.disablePredictive("Menu");
WLEvent.on("ParseScreen", function(event) {
  if (event.containsTextAt(2, 3, "Outbound Pick")) {
    var menuItem = event.createMenuItem(2, 3, "Outbound Pick", "3{AutoEnter}");
    menuItem.setBold(true);
    menuItem.setItalic(true);
    menuItem.setUnderline(true);
    menuItem.alignCenter();
    menuItem.fontSize(24);
    event.add(menuItem);
 
    for (var i = 0; i < 7; i ++) {
      event.markScreen(i, 0, 80);
    }
  }
});

Example of linking functions to screens

ModernScreen.disablePredictive("Menu");
WLEvent.on("ParseScreen", function(event) {
  event.addFunctionCall("FUNCTION_NAME", ["VALUE1", VALUE2, ...]);
});

Attributes returned by getAttributeAt()

Colors for foreground and background

Triggered before connection to the host. This event can be used to alter host profile settings before the connection is made. This event is only triggered in the “beforeSession” scope. The event.connect() must be called if this event handler is registered, otherwise the host profile will never connect and will remain at the connecting screen.

Added in version 1.2.109

When the Quick Launch button is pressed.

Added in 2.1.11

When scan data is received from the scanner. This event may be used to alter scan data before it is sent to the host.

When a TE screen update is received from the host system. There are no properties in the event object.

Added in version 1.2.104

When a speech result is received from the voice recognition engine.

Added in version 1.2.104

This event is fired when a JavaScript alert is received by the browser. This event may be used to alter the alert message or use the speech engine to speak the alert text. The event also allows the JavaScript alert to be suppressed.

Added in version 2.1.7

This event is fired when a download would occur in the Android web browser. This event may be use to override the default handling of the download. The default handling launches the default viewer for PDF files on the Android device.

Added in version 2.1.21