key Parameter

Maps a physical key to a logical key.

Scope: Global

Syntax

query key.PhysicalKeyName 
set key.PhysicalKeyName LogicalKeyName 

Options

PhysicalKeyName 
The name of the key that is pressed.
LogicalKeyName 
Your operating system may reserve certain function keys or key combinations, such as F1, for special purposes. With these exceptions, permitted values for LogicalKeyName are:
nnn 
A decimal-based ASCII character code, where n is a digit of value 0 to 9, inclusive. For example, character code 065 = A.
xnn 
xnnn 
A hexadecimal-based ASCII character code, where n is a digit of value 0 to 9, inclusive, or an alphabetic character of value A to F or a to f, inclusive. For example, character code x41 = A.
any letter key 
An alphabetic character of value A to Z or a to z, inclusive.
c-a to c-z 
Ctrl+letter keys
c-0 to c-9 
Ctrl+number keys. (The number keys on the numeric keypad are excluded.)
a-a to a-z 
Alt+letter keys
a-0 to a-9 
Alt+number keys. (The number keys on the numeric keypad are excluded.)
f1 to f12 
Function keys
s-f1 to s-f12 
Shift+Function keys
c-f1 to c-f12 
Ctrl+Function keys
a-f1 to a-f12 
Alt+Function keys
buttonNdouble 
A double click on button N (N = 1, 2, or 3; although only 1 and 2 will be usable on a two-button mouse.)
buttonNdown 
A single click on button N
buttonNdrag 
Drag mouse with button N down
a named key 
The following key names can be used, either alone or in combination with the Alt or Ctrl keys:
Backspace
Tab
Backtab
Enter
Esc
PadEnter

The following key names can be used, either alone or in combination with the Alt, Ctrl, or Shift keys:

PgUp
PgDn
End
Home
Left
Up
Right
Down
 
Ins
Del
 

Description

The key parameter provides a simple way of remapping the keyboard. Pressing the key identified by PhysicalKeyName has the same effect as pressing the LogicalKeyname key.

Example

To assign the function of the home key to Ctrl+F4, type:

set key.c-f4 home 

API Return Code

-2 
The Editor could not find the specified PhysicalKeyName.

action Parameter
keylist Parameter