View source for Vcl.Controls.TControl.OnContextPopup

{{#lst:API:Vcl.Controls.TControl.OnContextPopup|api}}
<!--Start API Documentation-->
==Description==
{{#ifeq: {{PAGENAME}} | Vcl.Controls.TControl.OnContextPopup | |{{InheritsFrom|Vcl.Controls.TControl.OnContextPopup}}}}

<section begin=short />Occurs when the user right-clicks the control or otherwise invokes the pop-up menu (such as using the keyboard).<section end=short />

The [[Vcl.Controls.TControl.OnContextPopup|OnContextPopup]] event handler is called when the user utilizes the mouse or keyboard to request a pop-up menu. The [[Vcl.Controls.TControl.OnContextPopup|OnContextPopup]] event is generated by a WM_CONTEXTMENU message, which is itself generated by the user clicking the right mouse button or by pressing SHIFT+F10 or the Applications key. 

This event is especially useful when the control does not have an associated pop-up menu (the PopupMenu property is not set) or if the AutoPopup property of the control's associated pop-up menu is '''False'''. However, the [[Vcl.Controls.TControl.OnContextPopup|OnContextPopup]] can also be used to override the automatic context menu that appears when the control has an associated pop-up menu with an <code>AutoPopup</code> property of '''True'''. In this last case, if the event handler displays its own menu, it should set the <code>Handled</code> parameter to '''True''' to suppress the default context menu.

The handler's <code>MousePos</code> parameter indicates the position of the mouse, in client coordinates. If the event was not generated by a mouse click, <code>MousePos</code> is (-1,-1).

{{Note|Parent controls receive an [[Vcl.Controls.TControl.OnContextPopup|OnContextPopup]] event before their child controls. In addition, for many child controls, the default window procedure causes the parent control to receive an [[Vcl.Controls.TControl.OnContextPopup|OnContextPopup]] event after the child control. As a result, when parent controls do not set <code>Handled</code> to '''True''' in an [[Vcl.Controls.TControl.OnContextPopup|OnContextPopup]] event handler, the event handler may be called multiple times for each context menu invocation.}}

[[Vcl.Controls.TControl.OnContextPopup|OnContextPopup]] is an event handler of type [[Vcl.Controls.TContextPopupEvent]].

===See Also===

* [[Vcl.Controls.TContextPopupEvent]]

* [[Vcl.Menus.TPopupMenu]]

* [[Vcl.Controls.TControl.PopupMenu]]

* [[Vcl.Menus.TPopupMenu.AutoPopup]]


[[Category:API Documentation]]
<!--End API Documentation-->