Keyboard Support

Contact and Search

Keyman.com Homepage

Header bottom

Keyman.com

Other versions
Version 15.0Version 14.0 (current version)Version 13.0Version 12.0Version 11.0Version 10.0Version 2.0 (home page)Version 1.0 (home page)

On this page

contextMatch (KCM) (Deprecated)

Summary

(Deprecated) Context matching: Returns true if context(n,ln,elem) == val.

Syntax

keyman.interface.contextMatch(n, Pelem, val, ln);

or

KeymanWeb.KCM(n, Pelem, val, ln); // Shorthand

Parameters

n
Type: number
Relative position of the caret for the context match attempt.
Pelem
Type: Element
The element being operated upon.
val
Type: string
The desired text value for context to match.
ln
Type: number
Number of characters of text context to match.

Return Value

boolean
true if the context matches the specified value val, otherwise false.

Description

This is a core element of keyboard input management within KeymanWeb in versions prior to 10.0, typically called automatically during keystroke processing events. For comparison with Developer 'rules' from keyboard source code, in the rule

"a" + "'" > "รก"

a keyboard would check that the initial context ("a") matches by using

keyman.interface.contextMatch(1, Pelem, "a", 1)

which checks, starting at the first character to the left of the caret, a single character to see if it matches the value "a".

For versions 10.0 and later, please consider use of fullContextMatch() instead.

See also

fullContextMatch(), keyman.interface.context(), keyman.interface.output(), keyman.interface.keyMatch()