Keyboard Support

Contact and Search

Keyman.com Homepage

Header bottom

Keyman.com

Other versions
Version 18.0Version 17.0 (current version)Version 16.0Version 15.0Version 14.0Version 13.0Version 12.0Version 11.0Version 10.0

On this page

You are viewing an old version of this documentation. Click here to open the current version, 17.0.

ifStore (KIFS)

Summary

ifStore compares the content of a system store with a string value.

Syntax

keyman.interface.ifStore(systemId, strValue, Pelem);

or

KeymanWeb.KIFS(systemId, strValue, Pelem);

Parameters

systemId
Type: number
The ID of the system store to test.
strValue
Type: string
The string value to be used for comparison.
Pelem
Type: Element
The page element currently active. (This parameter exists for use by possible future extensions.

Return Value

boolean
true if the value matches that of the system store, otherwise false.

Description

Only system IDs 31 (platform) and 33 (layer) are currently supported.

For platform, any combination of the following may be tested against the current device and browser:

  • Input method:
    ['touch', 'hardware']
  • any combination of OS:
    ['windows', 'android', 'ios', 'macosx', 'linux']
  • form factor:
    ['desktop', 'tablet', 'phone']
  • browser:
    ['native', 'web', 'ie', 'chrome', 'firefox', 'safari', 'opera']

Only one of each category may be matched at a time.

See also

keyman.interface.setStore()