The requested page is not available for the requested platform. You are viewing the content for Default platform.

DashboardDesigner.PopupMenuShowing Event

Allows you to customize a popup menu invoked by end-users in the DashboardDesigner.

Namespace: DevExpress.DashboardWin

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

Declaration

public event DashboardPopupMenuShowingEventHandler PopupMenuShowing
Public Event PopupMenuShowing As DashboardPopupMenuShowingEventHandler

Event Data

The PopupMenuShowing event handler receives an argument of the DashboardPopupMenuShowingEventArgs type. The following properties provide information specific to this event.

Property Description
Allow Gets or sets whether end-users can invoke a popup menu.
ButtonType Gets the type of the clicked command button.
DashboardArea Gets the value that identifies a popup menu location within the dashboard.
DashboardItemArea Gets the area of the dashboard item for which the event has been raised.
DashboardItemName Gets the name of the dashboard item for which the event has been raised.
(Inherited from DashboardItemMouseEventArgs)
Data Gets the dashboard item's client data.
Menu Gets or sets a popup menu.

Remarks

The DashboardDesigner.PopupMenuShowing event occurs when an end-user invokes a popup menu. This event allows you to customize a popup menu, invoked when an end-user right-clicks the dashboard item or clicks a command button in the dashboard title or 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.

A popup menu can be customized for the DashboardViewer as well. To do this, handle the DashboardViewer.PopupMenuShowing event.

See Also