mirror of
https://github.com/keymanapp/keyman.git
synced 2026-08-05 16:35:33 +00:00
47 lines
1.4 KiB
Markdown
47 lines
1.4 KiB
Markdown
---
|
|
title: 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`](../IKeymanKeyboard/DefaultBCP47Languages)
|
|
property. This method is the same as calling
|
|
[`IKeymanKeyboardsInstalled::Install`](../IKeymanKeyboardsInstalled/Install)
|
|
and passing the
|
|
[`IKeymanKeyboard::Filename`](../IKeymanKeyboard/Filename) property from
|
|
this instance.
|
|
|
|
This method requires elevated privileges.
|
|
|
|
## Specification
|
|
|
|
``` clike
|
|
void Install(bool Force)
|
|
```
|
|
|
|
## Parameters
|
|
|
|
`Force`
|
|
: If `True`, overwrites an existing keyboard entry.
|
|
|
|
## See also
|
|
|
|
[`IKeymanKeyboardsInstalled::Install`](../IKeymanKeyboardsInstalled/Install)
|
|
: Installs a keyboard file and input method for default language
|
|
|
|
[`IKeymanKeyboardsInstalled::Install2`](../IKeymanKeyboardsInstalled2/Install2)
|
|
: Installs a keyboard file, optionally with input method for default
|
|
language
|
|
|
|
[`IKeymanKeyboardFile2::Install2`](../IKeymanKeyboardFile2/Install2)
|
|
: Installs a keyboard file, optionally with input method for default
|
|
language
|