<< Click to Display Table of Contents >> Navigation:  Management > DefineKey

[GUI Control Only, not supported by the Community Edition]

This method allows you to define your own key for each available keyboard function.

method void VPE.DefineKey(

KeyFunction [long] Function,

Keys [long] KeyCode,

Keys [long] AddKeyCode1,

Keys [long] AddKeyCode2

)

KeyFunction [long] Function

All available keyboard functions are enumerated in the VKEY_xyz constants (see below).

Keys [long] KeyCode, AddKeyCode1, AddKeyCode2

Virtual keycode constants (defined in the Windows SDK) for the keys that need to be pressed at once for the specified function. Add-on keys like Ctrl, Alt and Shift may not be used in the parameter KeyCode, use these key codes in the parameters AddKeyCode1 or AddKeyCode2.

Remarks:

A keyboard function can be set to "undefined" = no key is associated with this keyboard function by setting all key code parameters to zero.

Example:

Active X / VCL:

Doc.DefineKey(VKEY_CLOSE, VK_ESCAPE, 0, 0)

Defines the key <ESC> to close the preview when pressed.

 

Doc.DefineKey(VKEY_CLOSE, VK_ESCAPE, VK_SHIFT, 0)

Defines the key pair <SHIFT> + <ESC> to close the preview when pressed.

 

Doc.DefineKey(VKEY_PRINT, 0, 0, 0)

There is no key associated with the keyboard function VKEY_PRINT.

 

.NET:

Doc.DefineKey(KeyFunction.Close, Keys.Escape, 0, 0)

Defines the key <ESC> to close the preview when pressed.

 

Doc.DefineKey(KeyFunction.Close, Keys.Escape, Keys.ShiftKey, 0)

Defines the key pair <SHIFT> + <ESC> to close the preview when pressed.

 

Doc.DefineKey(KeyFunction.Print, 0, 0, 0)

There is no key associated with the keyboard function "Print".

 

 

Possible values for the parameter "Function" are:

 

See also:

SendKey