IKeymanPackage Interface

Introduction

The IKeymanPackage interface describes a keyboard package in Keyman Engine for Windows API. It is a base class and describes both installed packages and package files. A keyboard package file is a bundle that contains keyboard layout(s), visual keyboards, documentation, fonts and any other related files to simplify distribution of keyboard layouts.

Interface Hierarchy

Properties

Author read only

Returns the author as listed in the package file.

AuthorEmail read only

Returns the email address of the author as listed in the package file.

Copyright read only

Returns the copyright message from the package file.

Filename read only

Returns the fully-qualified filename of the package file.

Files read only

Returns an IKeymanPackageContentFiles reference which lists the files included within the package.

Fonts read only

Returns an IKeymanPackageContentFonts reference which lists the fonts included within the package.

Graphic read only

Returns an IPicture reference for the install screen graphic included within the package, or null if no install screen graphic was included.

GraphicFile read only

Returns an IKeymanPackageContentFile reference for the install screen graphic included within the package, or null if no install screen graphic was included.

ID read only

Returns the identifier for the package, which is the base name of the package file without extension.

Keyboards read only

Returns an IKeymanPackageContentKeyboards reference which lists the keyboard layouts included within the package.

Name read only

Returns the descriptive name of the package file.

ReadmeFile read only

Returns an IKeymanPackageContentFile reference for the install Readme HTML file included within the package, or null if no Readme file was included.

Version read only

Returns the version string from the package file.

Website read only

Returns the website of the package as listed in the package file.

WelcomeFile read only

Returns an IKeymanPackageContentFile reference for the welcome.htm documentation HTML file included within the package, or null if no documentation was included.