IKeymanKeyboardFile::Install Method
Introduction
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.
Specification
void Install(bool Force)
Parameters
Force
- If
True
, overwrites an existing keyboard entry.
See also
IKeymanKeyboardsInstalled::Install
- Installs a keyboard file and input method for default language
IKeymanKeyboardsInstalled::Install2
- Installs a keyboard file, optionally with input method for default language
IKeymanKeyboardFile2::Install2
- Installs a keyboard file, optionally with input method for default language