IsContextualClick

From Xojo Documentation

Revision as of 20:18, 13 August 2021 by Gperlman (talk | contribs) (Notes)
You are currently browsing the old Xojo documentation site. Please visit the new Xojo documentation site!


Method

Indicates if the contextual mouse button has been clicked. It is True if the contextual button has been clicked and False if not.

Syntax

result=IsContextualClick

Part Type Description
result Boolean True if the contextual mouse button has been clicked and False if it was not.

Notes

A contextual click varies depending on platform and user settings. Most often it is done by right-clicking the mouse. On macOS, a contextual click is also triggered by holding the control key down while left clicking.

Generally speaking, if you want to show a contextual menu, you should use the ConstructContextualMenu and ContextualMenuAction events to row contextual menus.

IsContextualClick is useful in the MouseDown event to check for a contextual click when you are not intending to display a menu.

Examples

To display an existing menu, you should use the Clone method as in this example:

If IsContextualClick Then
Var m As MenuItem
m = EditMenu.Clone.PopUp
End If

See Also

MenuItem, ConstructContextualMenu, ContextualMenuAction