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 Desktop online update check tool is currently running.

IsTextEditorOpen() : Returns True if the Keyman Desktop 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 Desktop help at the specific topic.

OpenTextEditor() : Opens Keyman Desktop text editor.

OpenUpdateCheck() : Opens Keyman Desktop 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.