AboutSupportDeveloper GuideVersion 38.126.82.61

Interface HotkeyEvent

Generated when a keyboard shortcut defined in the hotkeys array in Window options is pressed inside the window.

Remarks

For reference on keyboard event properties see KeyboardEvent.

interface HotkeyEvent {
    altKey: boolean;
    code: string;
    command?: string;
    ctrlKey: boolean;
    inputType: "keyUp" | "keyDown";
    key: string;
    metaKey: boolean;
    name: string;
    repeat: boolean;
    shiftKey: boolean;
    topic: "window";
    type: "hotkey";
    uuid: string;
}

Properties

altKey code command? ctrlKey inputType key metaKey name repeat shiftKey topic type uuid

Properties

altKey

altKey: boolean

code

code: string

Optional command

command?: string

ctrlKey

ctrlKey: boolean

inputType

inputType: "keyUp" | "keyDown"

key

key: string

metaKey

metaKey: boolean

name

name: string

repeat

repeat: boolean

shiftKey

shiftKey: boolean

topic

topic: "window"

The "kebab-case" classname of the emitter that raised the event.

Remarks

OpenFin.Frame is represented as iframe.

type

type: "hotkey"

The type of event that was raised. Equal to the typename of the event payload in "kebab case".

Remarks

Guaranteed to be unique within each topic, but can be repeated between topics (e.g. WebContentsEvents.CrashedEvent and ApplicationEvents.CrashedEvent).

uuid

uuid: string

Settings

Theme

On This Page

altKeycodecommandctrlKeyinputTypekeymetaKeynamerepeatshiftKeytopictypeuuid