User manual - Web_Browser_Prog_Guide

Manuals Brands Casio Manuals Handhelds Naurtech CETerm

Web Browser

Programming Guide

for Version 5.1

Naurtech Terminal Emulation and Web

Browser Smart Clients

for Windows CE Devices

CETerm | CE3270 | CE5250 | CEVT220

Summary of content (79 pages)

PAGE 1

Web Browser Programming Guide for Version 5.
PAGE 2

NAURTECH W EB BROWSER SMART CLIENTS FOR W INDOWS CE .NET / POCKET PC Copyright Notice This document may not be reproduced in full, in part or in any form, without prior written permission of Naurtech Corporation. Naurtech Corporation makes no warranties with respect to the contents of this document and specifically disclaims any implied warranties of merchantability or fitness for any particular purpose.
PAGE 3

NAURTECH W EB BROWSER SMART CLIENTS FOR W INDOWS CE .NET / POCKET PC Table of Contents Copyright Notice .............................................................................................................................. 2 Trademarks...................................................................................................................................... 2 Software Version ..................................................................................................................
PAGE 4

NAURTECH W EB BROWSER SMART CLIENTS FOR W INDOWS CE .NET / POCKET PC 4.1 Navigating to Pre-configured URLs ..................................................................................... 42 4.2 Controlling the Scanner ....................................................................................................... 42 4.3 Input Focus and the Tab Key............................................................................................... 44 4.4 Session Launcher .............................
PAGE 5

NAURTECH W EB BROWSER SMART CLIENTS FOR W INDOWS CE .NET / POCKET PC Preface All of us at Naurtech Corporation constantly strive to deliver the highest quality products and services to our customers. We are always looking for ways to improve our solutions. If you have comments or suggestions, please direct these to: Naurtech Corporation e-mail: contact@naurtech.com Phone: +1 (425) 837.
PAGE 6

NAURTECH W EB BROWSER SMART CLIENTS FOR W INDOWS CE .NET / POCKET PC … Additional Documentation The Naurtech Web Browser is an integral feature of Naurtech terminal emulation Smart Clients. Please refer to the User’s Manual for these Smart Clients for detailed installation and configuration information. The User’s Manual may be downloaded from the “Support” section of our website.
PAGE 7

1.0 Introduction The Naurtech Web Browser provides a robust and flexible environment for Web based applications which are accessed from a mobile device. This browser is available for Windows CE .NET, Windows CE 5.0, Windows Mobile 2003 and Windows Mobile 5.0 based devices. Device tailored versions of the browser are available for most industrial terminals. These versions integrate with the peripherals on each device, such as barcode scanner, magnetic stripe reader, RFID reader and Bluetooth printer.
PAGE 8

NAURTECH W EB BROWSER SMART CLIENTS FOR W INDOWS CE .NET / POCKET PC can hide the Windows CE “Start” button, the whole Start bar and/or the application menu bars and toolbars. Users are prevented from navigating to un-authorized Web sites as is possible with Pocket IE. • • • • • • • Multiple Browser Sessions. All Naurtech clients allow up to 4 simultaneous sessions. Each session can be connected to a different Web application. This allows quick access to separate applications.
PAGE 9

NAURTECH W EB BROWSER SMART CLIENTS FOR W INDOWS CE .NET / POCKET PC • • Notification Features. Sound (.wav) files, tone generators (beepers), and vibrators can all be activated on devices which have these capabilities Context Menus. Custom context menus can be defined to provide access to special actions without tying up valuable screen real-estate.
PAGE 10

2.0 Common Tasks This section describes some common ways that enhanced features can be used within a Web based application. Here we show how to manage scanner input, invoke actions via keys, and interact with the handheld device. Only small code “snippets” are shown. For complete details see the reference sections of this manual. These tasks help to illustrate the power of the Naurtech Web Browser for building Web based applications. 2.
PAGE 11

NAURTECH W EB BROWSER SMART CLIENTS FOR W INDOWS CE .NET / POCKET PC function onscan(data, source, type, time, length) { if (length > 5) { document.form[0].barcode.value = data; document.form[0].submit(); } } <\script> 2.2 KEY ACTIONS In many situations, a Web application will be written to make special use of the keys on a handheld. The device may be used without a stylus or there may be function keys (Fx) which the application uses to perform special actions.
PAGE 12

NAURTECH W EB BROWSER SMART CLIENTS FOR W INDOWS CE .NET / POCKET PC 2.3 TEXT INPUT ELEMENTS All Web applications will use text input elements at some point to collect information such as a barcode or count. The standard text input element is the HTML INPUT such as The capabilities of the text input element are different for different Windows CE platforms. The Windows Mobile platform has the most limited text input.
PAGE 13

NAURTECH W EB BROWSER SMART CLIENTS FOR W INDOWS CE .NET / POCKET PC Or, you can toggle the SIP visibility from a link: Toggle Soft Input Panel (SIP) Or, you can perform the action from JavaScript by setting the document location: When the login is successful the application would store the current user name for the next login attempt ... function onlogin( username ) { // Login was successful document.CEBrowseX.
PAGE 17

3.0 Special HTML META Tags This section describes the special META tags (or elements) that are recognized by the Naurtech Web Browser and are used to convey special instructions to the browser. The META tags use the standard HTML format but are not recognized by standard browsers. These special META tags assign hotkeys, control the scanner, configure the device, and other tasks.
PAGE 18

NAURTECH W EB BROWSER SMART CLIENTS FOR W INDOWS CE .
PAGE 19

NAURTECH W EB BROWSER SMART CLIENTS FOR W INDOWS CE .NET / POCKET PC This message should not be visible. 3.2 BATTERY The Battery tag is used to configure the on-screen battery strength meter. This meter overlays the HTML content and is updated at a specified interval. You can change the location and style of the meter. Available styles include a horizontal or vertical single bar meter or filled battery icon.
PAGE 20

NAURTECH W EB BROWSER SMART CLIENTS FOR W INDOWS CE .NET / POCKET PC specify the update interval and a notification when the strength falls below a designated level. Example The horizontal battery icon should be visible. ... 3.
PAGE 21

NAURTECH W EB BROWSER SMART CLIENTS FOR W INDOWS CE .NET / POCKET PC ... 3.4 COMMAND The Command tag performs actions which affect the client application.
PAGE 22

NAURTECH W EB BROWSER SMART CLIENTS FOR W INDOWS CE .NET / POCKET PC 3.5 CURSORPOS The CursorPos tag is used to reposition the “busy-cursor” when it is visible. The busy cursor may appear while waiting for pages to load.
PAGE 23

NAURTECH W EB BROWSER SMART CLIENTS FOR W INDOWS CE .NET / POCKET PC Comments This tag should be the first special META tag defined on the page, but not before any JavaScript methods that may be invoked by the content. If this tag is not specified, errors are reported via popup messages.
PAGE 24

NAURTECH W EB BROWSER SMART CLIENTS FOR W INDOWS CE .NET / POCKET PC This page reports unit information. ... 3.8 HOMEKEY The HomeKey tag enables the “home key” (F5) to navigate to the current home URL.
PAGE 25

NAURTECH W EB BROWSER SMART CLIENTS FOR W INDOWS CE .NET / POCKET PC Syntax http-equiv="IDA" content="IDA_symbolicname" Comments This tag offers rich functionality. It is used primarily when an action is needed upon loading a page. Alternatively, an “onload” handler can be used in the BODY element to perform actions via JavaScript. A list of IDA Action Codes and their description can be found in the Appendix. All IDA symbolic names must be in upper case.
PAGE 26

NAURTECH W EB BROWSER SMART CLIENTS FOR W INDOWS CE .NET / POCKET PC Use MoveSIP to move the default SIP location. WARNING: MoveSIP may move the SIP to a non-visible location. Usually, entering the CETerm configuration dialogs will temporarily restore the SIP to the default location. Also, window and scroll behavior may be erratic on Windows Mobile devices with the SIP in a nonstandard location.
PAGE 27

NAURTECH W EB BROWSER SMART CLIENTS FOR W INDOWS CE .NET / POCKET PC Main Menu
1. Cycle Count
2. Inventory
3. Receiving
Select an action:
Press ‘A’ to check version.
... 3.
PAGE 28

NAURTECH W EB BROWSER SMART CLIENTS FOR W INDOWS CE .NET / POCKET PC format yields HTML that is easier to read and maintain. See OnAllKeys to direct all key input to a single action. Although most VK codes are uniform across devices, some devices can remap the keyboard at a driver level to change the VK codes. Consult your hardware documentation to understand what VK codes are generated by the keys on your device.
PAGE 29

NAURTECH W EB BROWSER SMART CLIENTS FOR W INDOWS CE .NET / POCKET PC Main Menu
4. Cycle Count
5. Inventory
6. Receiving
Select an action:
Press ‘A’ to check version.
...

3.
PAGE 30

NAURTECH W EB BROWSER SMART CLIENTS FOR W INDOWS CE .NET / POCKET PC 3.14 REBOOT The Reboot tag will invoke a warm (soft) or cold (hard) reset of the device. WARNING: Do not perform the cold reset unless you are prepared to lose all current settings, data, and add-on programs on the device. Syntax http-equiv="Reboot" content="Warm" "Cold" Comments This tag is supported for compatibility with other browsers.
PAGE 31

NAURTECH W EB BROWSER SMART CLIENTS FOR W INDOWS CE .NET / POCKET PC This tag is used to enable or disable the scanner when a page is first loaded. You can also use the IDA codes IDA_SCAN_RESUME and IDA_SCAN_SUSPEND to change the state from an IDA META tag, an “ida:” URL or dynamically via a PostIDA call. We do not support the “AutoEnter” or “AutoTab” content values. These values are un-needed because these and more complex scanner post-ambles can be configured within the Naurtech Web Browser.
PAGE 32

NAURTECH W EB BROWSER SMART CLIENTS FOR W INDOWS CE .NET / POCKET PC There are two variants of the ScannerNavigate command for compatibility with other browsers. The first uses 5 parameters and the second uses 3 parameters. For the 5 parameter version, the “%s” are replaced with (1) barcode data, (2) source scanner name, (3) symbology type, (4) timestamp, and (5) barcode length. For the 3 parameter version, the “%s” are replaced with (1) barcode data, (2) symbology type, and (3) timestamp.
PAGE 33

NAURTECH W EB BROWSER SMART CLIENTS FOR W INDOWS CE .NET / POCKET PC alert("Form full, scan discarded."); } } 3.17 SETDATE The SetDate tag is used to set the current system date on the handheld. Syntax http-equiv="SetDate" content="mm/dd/yyyy" "mm,dd,yyyy" "mm-dd-yyyy" Where mm is the month, dd is the day, and yyyy is the year. The date must be expressed in Coordinated Universal Time (UTC). You must use leading zeros for the day and month if less than 10.
PAGE 34

NAURTECH W EB BROWSER SMART CLIENTS FOR W INDOWS CE .NET / POCKET PC Comments If the time format is invalid, this tag is ignored. Example ... 3.19 SIGNAL The Signal tag is used to configure the on-screen WLAN (RF) signal strength meter. This meter overlays the HTML content and is updated at a specified interval. You can change the location and style of the meter.
PAGE 35

NAURTECH W EB BROWSER SMART CLIENTS FOR W INDOWS CE .NET / POCKET PC This tag is used to control the WLAN (RF) meter display. The meter may also be controlled within the CETerm configuration, independent of the Signal tag. The Signal tag will always override the internal configuration and will persist until changed by another Signal tag. Within the CETerm configuration you can specify the update interval and a notification when the strength falls below a designated level.
PAGE 36

NAURTECH W EB BROWSER SMART CLIENTS FOR W INDOWS CE .NET / POCKET PC Example ... 3.
PAGE 37

NAURTECH W EB BROWSER SMART CLIENTS FOR W INDOWS CE .NET / POCKET PC Example The Soft Input Panel (SIP) should be visible. 3.22 SIPUP The SIPUp tag makes the Soft Input Panel (SIP) visible. Syntax http-equiv="SIPUp" content="" Comments This tag is supported for compatibility with other browsers.
PAGE 38

NAURTECH W EB BROWSER SMART CLIENTS FOR W INDOWS CE .NET / POCKET PC "Larger" "Largest" Comments The TextSize tag is somewhat misnamed. Relative text sizes are determined by the HTML content. TextSize applies an overall zoom factor to the sizes set in the HTML. The initial zoom value will be the last value set for the session whether by a TextSize tag or by manual actions. Example This is the Largest TextSize zoom. ...
PAGE 39

NAURTECH W EB BROWSER SMART CLIENTS FOR W INDOWS CE .NET / POCKET PC Syntax http-equiv="TimerNavigate" content="javascript:OnTimer('%s');" content="/timer.htm?time=%s" Where the “%s” is replaced with the current time in the form hh:mm:ss. Comments The effect of TimerInterval and TimerNavigate tags can be accomplished using the Javascript setInterval() and setTimeout() methods on the window DOM object. Using the Javascript methods is recommended.
PAGE 40

NAURTECH W EB BROWSER SMART CLIENTS FOR W INDOWS CE .NET / POCKET PC Comments This tag is supported for compatibility with other browsers. It is preferable to use other techniques for sending print content to a printer. See the advanced topic “Printing from HTML”. The status code of the print action will be substituted into the “%ld” location. A status of 0 indicates success, 1 indicates failure. See ZebraLabel_Print for more details.
PAGE 41

NAURTECH W EB BROWSER SMART CLIENTS FOR W INDOWS CE .NET / POCKET PC (0x0a) character. The sequence “\xXX” is replaced by a byte with the hexadecimal value XX. Use “\\” for a literal backslash. The content is sent to the printer that is currently configured under the CETerm Printer tab. This may be a serial attached printer, Bluetooth, or network accessible printer.
PAGE 42

4.0 Advanced Topics In this chapter, we discuss several common, but advanced, topics for creating robust Web based applications. We discuss how to overcome some limitations of the Pocket IE browser behavior. 4.1 NAVIGATING TO PRE-CONFIGURED URLS The Naurtech Web Browser allows you to configure pre-defined URL’s which can be associated with a hardware key, a KeyBar button, or activated from the within the browser via a link or via JavaScript.
PAGE 43

NAURTECH W EB BROWSER SMART CLIENTS FOR W INDOWS CE .NET / POCKET PC ... ... ...
PAGE 44

NAURTECH W EB BROWSER SMART CLIENTS FOR W INDOWS CE .NET / POCKET PC } 4.3 INPUT FOCUS AND THE TAB KEY One of the first limitations you are likely to notice about Pocket Internet Explorer is that the Tab key does not always move the input focus as you expect from using the desktop Internet Explorer. Pocket IE on the Pocket PC 2002 and Windows Mobile platforms has the most limited behavior. The Naurtech Web Browser provides enhanced focus control on the Pocket PC platforms.
PAGE 45

NAURTECH W EB BROWSER SMART CLIENTS FOR W INDOWS CE .
PAGE 46

NAURTECH W EB BROWSER SMART CLIENTS FOR W INDOWS CE .NET / POCKET PC document.form1.scan2.value = ""; document.form1.scan3.value = ""; ring(); document.form1.scan1.focus(); } // Play a sound function ring() { external.OS.PlayTone(10, 1000, 200); } // Handle the scan data function onscan(data, source, type, time, length) { var current = document.activeElement; if (current == document.form1.scan1 || current == document.form1.scan2 || current == document.form1.scan3) { current.
PAGE 47

NAURTECH W EB BROWSER SMART CLIENTS FOR W INDOWS CE .NET / POCKET PC onload="javascript:document.myform1.textx1.
PAGE 48

NAURTECH W EB BROWSER SMART CLIENTS FOR W INDOWS CE .NET / POCKET PC // Focus has moved, cancel the event return -1; } // Just return the same key return 0; } 4.4 SESSION LAUNCHER One interesting use of the Web Browser is as a launcher for other browser or terminal emulation sessions. The following example shows how a static web page on the device could be used to activate other sessions. This example assumes that this web page is displayed under Session 4.
PAGE 49

NAURTECH W EB BROWSER SMART CLIENTS FOR W INDOWS CE .NET / POCKET PC sendida( "IDA_SESSION_S4", 0 ); } function startsession(id) { if (id >= 1 && id <=4) { // Switch to session sendida("IDA_SESSION_S" + id, 0); // Connect if not connected sendida("IDA_SESSION_CONNECT", id); return; } else { alert("Unsupported session."); } } function sendida(ida, s) { // PocketPC 2002 //CEBrowseX.CETerm.SendIDA(ida, s); // Windows Mobile document.CEBrowseX.CETerm.SendIDA(ida, s); } 4.
PAGE 50

NAURTECH W EB BROWSER SMART CLIENTS FOR W INDOWS CE .NET / POCKET PC var serial; var ceuuid; var version; function saveunitinfo(serialarg, ceuuidarg, versionarg) { serial = serialarg; ceuuid = ceuuidarg; version = versionarg; } ....check version variable and return info to host.... Alternatively, you can use a CEBrowseX or “external” object to retrieve the version in a CETerm.GetProperty call.
PAGE 51

NAURTECH W EB BROWSER SMART CLIENTS FOR W INDOWS CE .NET / POCKET PC On the text INPUT element we support the “stiscan” and “stisubmit” attributes. If present, the stiscan attribute controls which symbologies may be inserted into the input element. If no value is specified, all symbologies are allowed. If an empty string is specified, no symbologies are allowed. When the “stisubmit” attribute is present, the enclosing form will be submitted after scanned data is inserted in the element.
PAGE 52

NAURTECH W EB BROWSER SMART CLIENTS FOR W INDOWS CE .NET / POCKET PC You can set the values of the currently configured network printer using the CETerm.SetProperty method on the CEBrowseX or “external” objects.
PAGE 53

5.0 Printing from HTML There are numerous ways to print from the Naurtech Web Browser. Once a printer is configured, print content may be specified via a special META tag, the CEBrowseX or “external” objects, the custom PRINT tag, or with any ActiveX control designed to print from a browser. The Naurtech Web Browser maintains the printer configuration within the Session configuration dialogs. Here you may specify a serial attached, Bluetooth, IrDA, or network attached printer.
PAGE 54

NAURTECH W EB BROWSER SMART CLIENTS FOR W INDOWS CE .NET / POCKET PC 5.4 ACTIVEX PRINTING CONTROLS There are numerous ActiveX controls available to send print content to a printer. These are available from handheld manufacturers, printer manufacturers, and third-party sources. All controls which follow accepted standards will work within the Naurtech Browser. Currently we do not recommend any specific control. 6.
PAGE 55

NAURTECH W EB BROWSER SMART CLIENTS FOR W INDOWS CE .NET / POCKET PC CLASSID The CEBrowseX CLASSID is: CLASSID="clsid:D14943BD-4900-453E-8582-725F21A57E0C" METHODS The following methods are available. Note that most are marked as deprecated (DEP) in favor of using the CETerm or OS object and their associated methods. The CETerm and OS objects are obtained from the corresponding CEBrowseX properties.
PAGE 56

NAURTECH W EB BROWSER SMART CLIENTS FOR W INDOWS CE .NET / POCKET PC The SendIDA method will attempt to complete the action before returning. We recommend using PostIDA rather than SendIDA. There are only rare situations when SendIDA must be used. SendText( text, session ) SendText sends a text string to the Web Browser and directs it to the specified session. Valid session values are 1-4. The special session value of 0 will send the command to the current session.
PAGE 57

NAURTECH W EB BROWSER SMART CLIENTS FOR W INDOWS CE .NET / POCKET PC PlayTone( volume, frequency, duration ) PlayTone will play a tone if supported by the handheld hardware. PlayTone is not available on the CEBrowseX object (see PlaySound). volume – is the volume 00 -10 (0 is off, 10 is loudest) frequency – is the frequency in Hz. duration – is the duration in millisec.
PAGE 58

7.0 TextX Control The Naurtech TextX control is a replacement for the HTML text input element on Pocket PC 2002 and Windows Mobile 2003 devices. The native HTML text input element does not support most events and many properties. Using the TextX object gives much greater control over user input. However, there are drawbacks to using the control, such as increased HTML complexity and no desktop equivalent to simplify development. This control is not installed when you install the Naurtech Web Browser.
PAGE 59

NAURTECH W EB BROWSER SMART CLIENTS FOR W INDOWS CE .
PAGE 60

NAURTECH W EB BROWSER SMART CLIENTS FOR W INDOWS CE .NET / POCKET PC objectname.SetFocus( select ) SetFocus will set the current focus to this TextX object. If select is true, then all of the text in the control will be selected. objectname.ShowSIP( visible ) ShowSIP will cause the SIP to be visible if the argument is true. It will hide the SIP if the argument is false. This may also be accomplished via an IDA code (see IDA Action Codes).
PAGE 61

NAURTECH W EB BROWSER SMART CLIENTS FOR W INDOWS CE .NET / POCKET PC Some font properties may conflict or may not yield visible differences on all devices. FontBold is equivalent to FontWeight=700. Specifying a font name will override some other attributes. To create a multi-line control, simply use a large HEIGHT. Multiline content with embedded “\r\n” cannot be set via a PARAM element. You can set such content dynamically in JavaScript via the Value property.
PAGE 62

NAURTECH W EB BROWSER SMART CLIENTS FOR W INDOWS CE .NET / POCKET PC may also be called when keys are simulated within the Web Browser via KeyBar buttons or remapped physical keys. int OnKeyPress( int akey ) The OnKeyPress handler is called when a key is pressed which generates an ASCII character. The akey argument contains the ASCII character which is generated. The return value from this handler controls the event propagation.
PAGE 63

Appendix 1 - Properties The properties listed in this appendix may be accessed via the GetProperty and SetProperty methods on the CEBrowseX ActiveX control or via the DOM “external” object under Windows CE .NET or 5.0. Properties marked (RO) are read-only and may not be set with SetProperty. ALERT: Use the CETerm object methods GetProperty and SetProperty to access properties. There are many additional properties described in the CETerm Scripting Guide.
PAGE 64

NAURTECH W EB BROWSER SMART CLIENTS FOR W INDOWS CE .NET / POCKET PC Property Name Session Properties Description session.connection.host session.connection.port session.connection.type Session host (or home URL) TE session port Session type 3270, 5250, VT220, HTML session.printer.network.
PAGE 65

Appendix 2 - IDA Action Codes Many IDA codes apply only to a Terminal Emulation session but are listed here for completeness. Some IDA codes can only be used in restricted circumstances, such as IDA_URL.
PAGE 66

NAURTECH W EB BROWSER SMART CLIENTS FOR W INDOWS CE .
PAGE 67

NAURTECH W EB BROWSER SMART CLIENTS FOR W INDOWS CE .
PAGE 68

NAURTECH W EB BROWSER SMART CLIENTS FOR W INDOWS CE .
PAGE 69

NAURTECH W EB BROWSER SMART CLIENTS FOR W INDOWS CE .
PAGE 70

NAURTECH W EB BROWSER SMART CLIENTS FOR W INDOWS CE .
PAGE 71

NAURTECH W EB BROWSER SMART CLIENTS FOR W INDOWS CE .
PAGE 72

NAURTECH W EB BROWSER SMART CLIENTS FOR W INDOWS CE .
PAGE 73

NAURTECH W EB BROWSER SMART CLIENTS FOR W INDOWS CE .
PAGE 74

Appendix 3 - Virtual Key Codes This appendix contains a list of Windows CE Virtual Key Codes (VK) which are used with the OnKey META tag. Notice that there is no case distinction of the alphabetic keys. Also, note that the symbols on the tops of the digit keys are not listed because they are a shift state of the digit keys.
PAGE 75

NAURTECH W EB BROWSER SMART CLIENTS FOR W INDOWS CE .
PAGE 76

NAURTECH W EB BROWSER SMART CLIENTS FOR W INDOWS CE .
PAGE 77

NAURTECH W EB BROWSER SMART CLIENTS FOR W INDOWS CE .
PAGE 78

Glossary CEBrowseX A Naurtech ActiveX control which provides access to the Naurtech Web Browser configuration and actions. external This is the name of an implied object in the DOM of the Windows CE .NET and CE 5.0 browser that gives access to special non-standard features. See the CEBrowseX documentation for details. GetProperty A method available via the CEBrowseX ActiveX object or the CE .NET “external” object to get a configuration value from the Web Browser.
PAGE 79

NAURTECH W EB BROWSER SMART CLIENTS FOR W INDOWS CE .