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

isKeypress (KIK)

Summary

Returns true if the input event corresponds to a keypress event resulting in character output.

Syntax

keyman.interface.isKeypress(e);

or

KeymanWeb.KIK(e); // Shorthand

Parameters

e
Type: Object
The event object to be evaluated.

Return Value

boolean
true if the event would produce text output, otherwise false.

Description

This function is designed to facilitate filtering of keystrokes, allowing custom-coded keyboards to ignore function-oriented keystroke events that should never be used for text generation, such as for F1-F12.

The logic corresponds to that for the keyboard language nomatch rule.