Overview
The SIP Module is used to control attributes of the soft input panel (SIP), also known as the software keyboard. Settings apply to text boxes on the current page as well as the address bar.
Syntax
| sip (Module) <META> Syntax |
|---|
<META HTTP-Equiv="SIP" content="[method / parameter]"> |
| Sip JavaScript Object Syntax: |
|---|
| By default the JavaScript Object 'sip' will exist on the current page and can be used to interact directly with the sip. |
|
To Invoke sip methods via JavaScript use the following syntax: sip.method();
e.g. sip.manual(); |
|
To Set sip parameters via JavaScript use the following syntax: sip.parameter = 'value'; remembering to enclose your value in quotes where appropriate.
e.g. sip.left = 'value'; |
|
To set multiple EMML parameters / events on a single line use the following syntax: sip.setEMML("[Your EMML Tags]");
e.g. sip.setEMML("left:valuemanual"); |
Methods
Items listed in this section indicate methods or, in some cases, indicate parameters which will be retrieved.
| Name | Description | Default Value |
|---|---|---|
| manual | The SIP will show or hide only when the SIP button is pressed. | manual |
| automatic | Shows and hides the SIP when editable fields have focus. | manual |
Parameters
Items listed in this section indicate parameters, or attributes which can be set.
| Name | Possible Values | Description | Default Value |
|---|---|---|---|
| left:[Value] | Horizontal position, in pixels | Sets the horizontal position of the SIP in pixels. (Not supported on Enterprise Tablet. Not compatible with Finger Scrolling on Windows devices) | Center of the screen |
| top:[Value] | Vertical position, in pixels | Sets the vertical position of the SIP in pixels. (Not supported on Enterprise Tablet. Not compatible with Finger Scrolling on Windows devices) | Bottom of the screen |
Multi Instance
When multiple RhoElememts applications are running the following considerations should be made: The SIP settings are application specific. Switching to another application which uses the SIP module will apply the focused application's settings to it, e.g. the SIP may move position.
Remarks
Disabling the SIP
If you want to completely disable to the use of the SIP, set it to appear off the visible area of the screen (see example above). You can use a default meta tag to avoid pasting the tag on every page. Alternatively on the Enterprise Tablet, call the manual method.
Interaction with Hardware Keyboard
The SIP used is the standard keyboard input panel supplied with Windows. Certain incompatibilities exist when using the software keyboard on a device which also has a hardware keyboard though this will have no impact on the average user. For example moving the SIP will reset the alpha or function key (orange or blue key) lock and using the orange or blue keys may reset the position of the SIP on certain devices. Also note that if you press a hardware key the SIP will disappear if you are using the Internet Explorer engine and you will need to press the SIP button again or return focus to an editable field to get it to appear
Interaction with Screen Rotation
Depending on the underlying operating system the SIP position may change following screen rotation. The SIP left and top parameters can be applied in a ScreenOrientationEvent to bypass this feature if required.
Backwards Compatibility
The SIP methods 'Manual' and 'Automatic' have slightly different behaviour when the configuration setting EngineInUse is set to Internet Explorer. Manual: When shown by the SIP Button, will show and hide when text boxes have focus. Automatic: Shows and hides when text boxes have focus. Applying SIP control Automatic will prevent SIP control Manual being applied in the same application. To return to Manual SIP control you can press a hardware key. In Backwards Compatibility mode Manual and Automatic do not apply for Windows CE, only Windows Mobile.
Requirements
| RhoElements Version | 1.0.0 or above |
|---|---|
| Supported Devices | All supported devices. left and top are not supported by the Enterprise Tablet |
| Minimum Requirements | None. |
| Persistence | Persistent - Changes to this module will persist when navigating to a new page. Moving the SIP may also persist after RhoElements has been shut down, dependent on Operating System. |
HTML/JavaScript Examples
The following example moves the SIP to sit at the bottom of a 1/4 VGA screen:
<META HTTP-Equiv="SIP" Content="Left:0;Top:240">
To completely disable the use of the SIP it can be positioned off the visible area of the screen.
<META HTTP-Equiv="SIP" Content="Left:640;Top:640">
The following example sets the SIP to manual:
<META HTTP-Equiv="SIP" Content="Manual">