Management Functions > VpeDefineKey

[Windows platform only; not supported by the Community Edition]

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

void VpeDefineKey(

VpeHandle hDoc,

int function,

int key_code,

int add_key_code1,

int add_key_code2

)

VpeHandle hDoc

Document Handle

int function

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

int key_code, add_key_code1, add_key_code2

Virtual keycode constants (defined in the Windows SDK) for the keys that need to be pressed at once for the specified function.

Remarks:

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

Example:

VpeDefineKey(hDoc, VKEY_CLOSE, VK_ESCAPE, 0, 0)

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

VpeDefineKey(hDoc, VKEY_CLOSE, VK_ESCAPE, VK_SHIFT, 0)

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

VpeDefineKey(hDoc, VKEY_PRINT, 0, 0, 0)

There is no key associated with the keyboard function VKEY_PRINT.

Possible values for the parameter "function" are: