OnEvent_MenuClicked

The OnEvent_MenuClicked event is fired when an item of a script menu is selected by the current user.

Syntax

OnEvent_MenuClicked(
    [string] MenuItemId,
    [enum] Location,
    [object] OriginWnd
);

Parameters

MenuItemId

[string] Identifier of the menu item that was selected by the current user.

Location

[enum] A number specifying the location of the menu that triggered the event. You can use this parameter to display a different menu depending on what the current user is currently doing.

  It can be one of the following values:

MENULOC_CONTACTLIST (1) MENULOC_CHATWND (2) MENULOC_MOBILEWND (3)

Contact List Messenger Chat Window Mobile Device Chat Window

OriginWnd

[object] If Location is 2 or 3, this parameter is the ChatWnd object attached to the chat window where the menu was displayed. Else, this parameter is undefined.

Return Value

No value has to be returned by this event.

Remarks

The script's menu can be defined statically in the ScriptInfo.xml file or returned by the OnGetScriptMenu event handler.

Messenger Plus! 4.23 and earlier: enumeration names are not available, numbers must be used instead.

Messenger Plus! 4.50 and earlier: MENULOC_MOBILEWND is not supported.

Event Information

See Also

Messenger Plus! Events, OnGetScriptMenu.