OnEvent_ChatWndEditKeyDown

The OnEvent_ChatWndEditKeyDown event is fired every time a key is pressed in the typing area of a chat window. It can be used to filter out some keys and use them as shortcuts for a feature of the script.

Syntax

[boolean] OnEvent_ChatWndEditKeyDown(
    [object] ChatWnd,
    [number] KeyCode,
    [boolean] CtrlKeyDown,
    [boolean] ShiftKeyDown
);

Parameters

ChatWnd

[object] Reference to the ChatWnd object attached to the chat generating the event.

KeyCode

[number] Virtual key code of the key that was pressed (as sent in WM_KEYDOWN). The list of possible codes can be found in the Virtual-Key Codes page of the MSDN Library.

CtrlKeyDown

[boolean] True if the Control key was pressed when the event was fired.

ShiftKeyDown

[boolean] True if the Shift key was pressed when the event was fired.

Return Value

A boolean value specifying if the key should be ignored. If the function returns true, the key is not processed by Messenger and not inserted in the typing area. If the function returns false, Messenger Plus! and Messenger continue their own processing of the message.

Remarks

Because this event is fired for every single key pressed by the user, your event handler must return as fast as possible and not slow down the user.

Event Information

See Also

Messenger Events, ChatWnd Object, Virtual-Key Codes.