FrameworkElement.ContextMenuOpening Event
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Occurs when any context menu on the element is opened.
public:
event System::Windows::Controls::ContextMenuEventHandler ^ ContextMenuOpening;public event System.Windows.Controls.ContextMenuEventHandler ContextMenuOpening;member this.ContextMenuOpening : System.Windows.Controls.ContextMenuEventHandler Public Custom Event ContextMenuOpening As ContextMenuEventHandler Event Type
Remarks
To manually open context menus, handlers of the events should mark the relevant event as handled. Otherwise, the existing value of the ContextMenu property will be used to automatically open a context menu. Marking the event handled will effectively cancel the default action, and could be an opportunity to reset the value of the ContextMenu property and then open the new ContextMenu. However, there is a timing issue you should be aware of. In order to completely replace the context menu through a ContextMenuOpening handler, the initial context menu must not be null / empty. Alternatively, you might need to handle the event and then manually open a new context menu. For details, see How to: Handle the ContextMenuOpening Event.
To use this event as an EventTrigger in a style, you must reference the underlying attached event:
<EventTrigger RoutedEvent="ContextMenuService.ContextMenuOpening">
<!-- storyboard here ... -->
</EventTrigger>
(This usage is required because the event implementation on FrameworkElement that exposes the underlying service event does not map the ContextMenuOpening identifier such that you can use it in triggers).
ContextMenu itself is a FrameworkElement derived class, but this event will not be raised from the context menu being opened as a source. The event is raised from the element that "owns" the context menu as a property and is only raised when a user attempts to open a context menu in the UI. It is possible for ContextMenu itself to have a ContextMenu property, but you should avoid this scenario (for details, see FrameworkElement.ContextMenu).
The ContextMenu class itself also has a similar event (Opened) but Opened does not provide you the opportunity to cancel the user action.
Routed Event Information
| Item | Value |
|---|---|
| Identifier field | ContextMenuOpeningEvent |
| Routing strategy | Bubbling |
| Delegate | ContextMenuEventHandler |
- Override OnContextMenuOpening to implement class handling for this event in derived classes.
