DashboardPopupMenuShowingEventArgs Class

Provides data for the DashboardViewer.PopupMenuShowing and the DashboardDesigner.PopupMenuShowing events.

Namespace: DevExpress.DashboardWin

Assembly: DevExpress.Dashboard.v19.1.Win.dll

Declaration

C#

public class DashboardPopupMenuShowingEventArgs :
    DashboardItemMouseHitTestEventArgs

VB.NET

Public Class DashboardPopupMenuShowingEventArgs
    Inherits DashboardItemMouseHitTestEventArgs

Related API Members

DashboardPopupMenuShowingEventArgs is the data class for the following events:

• DashboardDesigner.PopupMenuShowing
• DashboardViewer.PopupMenuShowing

Remarks

The DashboardViewer.PopupMenuShowing and the DashboardDesigner.PopupMenuShowing events occur when an end-user invokes a popup menu and allows you to customize this menu. A customizable popup menu can be invoked when an end-user:

• right-clicks the dashboard item;
• clicks a command button in the dashboard title;
• clicks a command button in the dashboard item caption.

To identify the popup menu location, use the DashboardPopupMenuShowingEventArgs.DashboardArea property. To get the area of the dashboard item for which the event has been raised, use the DashboardPopupMenuShowingEventArgs.DashboardItemArea property. To obtain the dashboard item name for which the event has been raised, use the DashboardItemMouseEventArgs.DashboardItemName property. To identify the clicked command button, use the DashboardPopupMenuShowingEventArgs.ButtonType property.

Use the DashboardPopupMenuShowingEventArgs.Menu property to customize a popup menu. To prevent end-users from invoking a popup menu, set the DashboardPopupMenuShowingEventArgs.Allow property to false or assign null to the DashboardPopupMenuShowingEventArgs.Menu property.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the DashboardPopupMenuShowingEventArgs class.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

dashboard-designer-how-to-import-shape-files-into-map-items-using-openfiledialog-t567206/CS/T566254/Form1.cs#L22

private void dashboardDesigner1_PopupMenuShowing(object sender, DashboardPopupMenuShowingEventArgs e) {
    var designer = (DashboardDesigner)sender;

winforms-dashboard-how-to-customize-the-dashboard-title-and-dashboard-item-captions-t630210/CS/CustomizeDashboardItemCaptionExample/ViewerForm1.cs#L90

private void DashboardViewer_PopupMenuShowing(object sender, DashboardPopupMenuShowingEventArgs e) {
    // Hide popup menu everywhere except the dashboard title, to hide commands related to the export actions.

VB.NET

dashboard-designer-how-to-import-shape-files-into-map-items-using-openfiledialog-t567206/VB/T566254/Form1.vb#L24

Private Sub dashboardDesigner1_PopupMenuShowing(ByVal sender As Object, ByVal e As DashboardPopupMenuShowingEventArgs) Handles dashboardDesigner1.PopupMenuShowing
    Dim designer = DirectCast(sender, DashboardDesigner)

winforms-dashboard-how-to-customize-the-dashboard-title-and-dashboard-item-captions-t630210/VB/CustomizeDashboardItemCaptionExample/ViewerForm1.vb#L92

Private Sub DashboardViewer_PopupMenuShowing(ByVal sender As Object, ByVal e As DashboardPopupMenuShowingEventArgs)
    ' Hide popup menu everywhere except the dashboard title, to hide commands related to the export actions.

Inheritance

Object

EventArgs

DashboardItemMouseEventArgs

DashboardItemMouseHitTestEventArgs

DashboardPopupMenuShowingEventArgs