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
Event Data
The PopupMenuShowing event's data class is DashboardPopupMenuShowingEventArgs. 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. Inherited from DashboardItemMouseHitTestEventArgs. |
| Menu | Gets or sets a popup menu. |
The event data class exposes the following methods:
| Method | Description |
|---|---|
| GetAxisPoint() | Returns the axis point corresponding to the visual element located under the test point. Inherited from DashboardItemMouseHitTestEventArgs. |
| GetAxisPoint(String) | Returns the axis point corresponding to the visual element located under the test point. Inherited from DashboardItemMouseHitTestEventArgs. |
| GetDeltas() | Gets a list of deltas corresponding to the visual element located under the test point. Inherited from DashboardItemMouseHitTestEventArgs. |
| GetMeasures() | Gets a list of measures corresponding to the visual element located under the test point. Inherited from DashboardItemMouseHitTestEventArgs. |
| GetSlice() | Returns the slice of client data by the axis point corresponding to the visual element located under the test point. Inherited from DashboardItemMouseHitTestEventArgs. |
| GetSlice(String) | Returns the slice of client data by the axis point corresponding to the visual element located under the test point. Inherited from DashboardItemMouseHitTestEventArgs. |
| GetUnderlyingData() | Returns underlying data corresponding to the visual element located under the test point. Inherited from DashboardItemMouseHitTestEventArgs. |
| GetUnderlyingData(IList<String>) | Returns underlying data corresponding to the visual element located under the test point. Inherited from DashboardItemMouseHitTestEventArgs. |
| GetUnderlyingData(String, IList<String>) | Returns underlying data corresponding to the visual element located under the test point. Inherited from DashboardItemMouseHitTestEventArgs. |
| GetUnderlyingData(String) | Returns underlying data corresponding to the visual element located under the test point. Inherited from DashboardItemMouseHitTestEventArgs. |
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.