spiegel-keyman/windows/docs/engine/api/IKeymanControl/index.md at 525589b8c8eb842e4e4888fcdd6ea9fbe293b047 - erabo/spiegel-keyman - Forgejo: Beyond coding. We Forge.

erabo/spiegel-keyman

mirror of https://github.com/keymanapp/keyman.git synced 2026-08-05 08:25:32 +00:00

Eberhard Beilharz f166f11d14

docs(common): update docs Keyman Desktop → Keyman for Windows

Also change path to engine help pages. This requires a corresponding
change in help.keyman.com.

Test-bot: skip

2025-09-02 14:29:53 +02:00

2.3 KiB

Raw Blame History

title
IKeymanControl Interface

Introduction

The IKeymanControl interface controls the operation of Keyman Engine and provides methods to trigger Keyman Engine's user interface.

Interface Hierarchy

IDispatch

IKeymanObject

IKeymanControl

Properties

ActiveLanguage: Returns or sets the currently active keyboard + language.

LastActiveWindow read only: Returns the last active window handle, excluding Keyman windows such as the On Screen Keyboard.

LastFocusWindow read only: Returns the last focus window handle, irrespective of process.

Methods

IsConfigurationOpen(): Returns True if Keyman Configuration is currently running.

IsKeymanRunning(): Returns True if Keyman Engine is currently running.

IsOnlineUpdateCheckOpen(): Returns True if the Keyman for Windows online update check tool is currently running.

IsTextEditorOpen(): Returns True if the Keyman for Windows text editor is currently running.

IsVisualKeyboardOpen(): Returns True if the on screen keyboard is running.

OpenConfiguration(): Starts Keyman Configuration.

OpenDiagnostics(): Opens the Keyman diagnostics tool.

OpenHelp(): Opens Keyman for Windows help at the specific topic.

OpenTextEditor(): Opens Keyman for Windows text editor.

OpenUpdateCheck(): Opens Keyman for Windows online update check tool.

ShowKeyboardWelcome(): Loads the welcome.htm file in a window for the selected keyboard.

StartKeyman(): Starts Keyman Engine, if it isn't already running.

StartVisualKeyboard(): Starts the on screen keyboard, if it isn't already visible.

StopKeyman(): Stops Keyman Engine.

StopVisualKeyboard(): Stops the on screen keyboard.