Method

# IsContextualClick

<div class="rst-class">

forsearch

</div>

Mouse

<div class="rst-class">

forsearch

</div>

Cursor

<div class="rst-class">

forsearch

</div>

Contextmenu

<div class="rst-class">

forsearch

</div>

ContextualMenu

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

## Description

Indicates if the contextual mouse button has been clicked. It is `True</api/language/true>` if the contextual button has been clicked and `False</api/language/false>` if not.

## Usage

``` xojo
result = IsContextualClick
```

| Part   | Type                               | Description                                                                                                                |
|--------|------------------------------------|----------------------------------------------------------------------------------------------------------------------------|
| result | `Boolean</api/data_types/boolean>` | `True</api/language/true>` if the contextual mouse button has been clicked and `False</api/language/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<desktopuicontrol.constructcontextualmenu>` and `ContextualMenuItemSelected<desktopuicontrol.contextualmenuitemselected>` events to row contextual menus.

<span class="title-ref">IsContextualClick</span> is useful in the MouseDown event to check for a contextual click when you are not intending to display a menu.

## Sample code

To display an existing menu, you should use the `Clone<desktopmenuitem.clone>` method as in this example:

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

## Compatibility

|                       |         |
|-----------------------|---------|
| **Project Types**     | Desktop |
| **Operating Systems** | All     |

<div class="seealso">

`DesktopMenuItem</api/user_interface/desktop/desktopmenuitem>`, `DesktopUIControl.ConstructContextualMenu<desktopuicontrol.constructcontextualmenu>`, `DesktopUIControl.ContextualMenuItemSelected<desktopuicontrol.contextualmenuitemselected>`

</div>