PopupMenuShowingEventArgs Class

Provides data for the PivotGridControl.PopupMenuShowing event.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.XtraPivotGrid.v20.1.dll

Declaration

public class PopupMenuShowingEventArgs :
    PivotGridMenuEventArgsBase
Public Class PopupMenuShowingEventArgs
    Inherits PivotGridMenuEventArgsBase

Remarks

The PivotGridControl.PopupMenuShowing event fires each time an end-user attempts to invoke a context menu, allowing you to identify which menu is about to be displayed, customize the menu or prevent it from being invoked. This event does not fire if showing the context menu is disabled via the PivotGridControl.OptionsMenu property.

The PopupMenuShowingEventArgs event parameter provides the PivotGridMenuEventArgsBase.Point and PopupMenuShowingEventArgs.HitInfo properties used to identify the right-clicked point and obtain which element is located under the point, respectively. If the point is located inside a field header or field value, use the PopupMenuShowingEventArgs.Field and PivotGridMenuEventArgsBase.Area properties, to identify which field has been right-clicked, and in which area this field resides, respectively.

Use the PivotGridMenuEventArgsBase.Menu property to obtain the context menu about to be displayed, and customize it. The type of the menu is identified via the PivotGridMenuEventArgsBase.MenuType property.

To specify whether to invoke the context menu, use the PivotGridMenuEventArgsBase.Allow property.

See Also