In This Topic ▼

getCtrlKeyValue Method

Summary

Returns the Ctrl KeyboardEvent boolean instance value.

Syntax

TypeScript

    static getCtrlKeyValue(code: KeyCode, e: KeyboardEvent): boolean;

Parameters

code

The KeyCode for the event, being the ctrl key for windows.

The browser's Keyboard event.

Return Value

true if a Ctrl KeyboardEvent value is returned in the browser's Keyboard event, false otherwise.

Remarks

The Meta key in Mac is equivalent to the ctrl key in other operating systems.

If we are running under mac, and meta is true, we will return the ctrl code as true. This would be used for ease of use so that keybindings do not have to be setup for each operation system.

Requirements

Target Platforms