Keyboard Support

Contact and Search Homepage

Header bottom

Other versions
Version 14.0 (current version)Version 10.0Version 9.0 (home page)

On this page

IKeymanKeyboardFile::Install Method


The IKeymanKeyboardFile::Install method installs the keyboard file (.kmx) into Keyman Engine for Windows. This includes copying the file into the Keyman Engine keyboard store, adding registry settings, and installing the Windows input method. As installing Windows input methods is an asynchronous process, this method may not be complete when it returns.

This method adds the keyboard to the default language as specified in the IKeymanKeyboard::DefaultBCP47Languages property. This method is the same as calling IKeymanKeyboardsInstalled::Install and passing the IKeymanKeyboard::Filename property from this instance.

This method requires elevated privileges.


void Install(bool Force)


If True, overwrites an existing keyboard entry.