KeysGetEnabled Method

Description

Check the enabled state of a particular key type.

Syntax

Visual Basic
Public Function KeysGetEnabled( _ ByVal Key As enumKeys _ ) As Boolean

Parameters

Key

Value	Description
KEYS_ACCELERATORS	Accelerator keys such as Ctrl-S to save the file.
KEYS_ACCELERATORS_FORWARD	Forward accelerator key messages to the Key Events.
KEYS_SYSTEM	System keys such as Break.
KEYS_SYSTEM_FORWARD	Forward system key messages to the Key Events.

An enumKeys option value to determine the enabled state of.

Return Type

When KeysEnabled is True for the special keys, the keys will be processed by the default container handling.
When KeysEnabled is False for the special keys, the keys will not be processed by the default container handling.
When KeysEnabled is True for the key forwards, then the special keys will be forwarded to the regular ImagXpress Key Events provided that the Key Events are enabled with the EventSetEnabled method.
When KeysEnabled is False for the key forwards, then the special keys will NOT be forwarded to the regular Key Events no matter how the Key Events are set with the EventSetEnabled method.

Remarks

Example

VB example of KeysGetEnabled/KeysSetEnabled (Visual Basic)

‘ Alt+F4 will now Exit Application When Alt+F4 Is pressed And ImagXpress has the focus.
ImagXpress1.KeysSetEnabled(KEYS_SYSTEM, True)

‘ Determine If pressing TAB key will change focus To next control.
Enabled = ImagXpress1.KeysGetEnabled(KEYS_ACCELERATOR)

Don’t fire the ImagXpress key events When Alt+F4 Is pressed.
ImagXpress1.KeysSetEnabled(KEYS_SYSTEM_FORWARD, False)

‘ Determine If the key events will be fired by pressing a TAB key.
Enabled = ImagXpress1.KeysGetEnabled(KEYS_ACCELERATOR_FORWARD)