The Keylight Module is used to illuminate / extinguish the keyboard backlight as well as setting the intensity of the keylight.
|keylight (Module) <META> Syntax|
<META HTTP-Equiv="Keylight" content="[method / parameter]">
|To set multiple EMML parameters / events on a single line use the following syntax: keylight.setEMML("[Your EMML Tags]"); e.g. keylight.setEMML("intensity:valueon");|
|Keylight Ruby Object Syntax:|
|To Invoke Keylight methods via Ruby use the following syntax: Keylight.method() e.g. Keylight.on|
|To Set Keylight parameters via Ruby use the following syntax: Keylight.parameter = 'value' remembering to enclose your value in quotes where appropriate. e.g. Keylight.intensity = 'value'|
Items listed in this section indicate methods or, in some cases, indicate parameters which will be retrieved.
|on||Turns the keyboard backlight on.||Device Dependant|
|off||Turns the keyboard backlight off.||Device Dependant|
Items listed in this section indicate parameters, or attributes which can be set.
|Name||Possible Values||Description||Default Value|
|intensity:[Value]||Positive Number, see remarks for range||Sets the keyboard backlight to the specified intensity.||Device Dependant|
When multiple RhoElememts applications are running the following considerations should be made: The keylight settings are application specific. Switching to another application which uses the keylight module will cause the keyboard illumination settings to change to those of the application with focus. Only the application with Focus will have the ability to change the keylight settings.
The intensity tag will only have an observable effect if the keyboard backlight is turned on, setting the intensity by its self is insufficient to illuminate the backlight.
The levels of supported keylight intensity is device dependant. When the Keylight module is first loaded it writes the supported levels to the log file as INFORMATION so you can determine the maximum setting from the log file.
|RhoElements Version||1.0.0 or above|
|Supported Devices||All supported devices except Enterprise Tablet.|
|Minimum Requirements||This tag requires appropriate hardware and drivers to run, i.e. a device with a keyboard backlight.|
|Persistence||Persistent - Changes to this module will persist when navigating to a new page.|
The following example turns the keyboard backlight on with an intensity of 3:
<META HTTP-Equiv="Keylight-On" Content="Intensity:3">