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

DashboardViewer.DashboardItemDoubleClick Event

Occurs when an end-user double-clicks a dashboard item.

Namespace: DevExpress.DashboardWin

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


public event DashboardItemMouseActionEventHandler DashboardItemDoubleClick
Public Event DashboardItemDoubleClick As DashboardItemMouseActionEventHandler

Event Data

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

Property Description
DashboardItemName Gets the name of the dashboard item for which the event has been raised.
Data Gets the dashboard item's client data.


Use the DashboardItemMouseEventArgs.DashboardItemName property to obtain the dashboard item name for which the event has been raised. The DashboardItemMouseHitTestEventArgs.Data property returns the client data for this dashboard item.

The DashboardItemMouseHitTestEventArgs.GetAxisPoint method returns the axis point related to the double-clicked dashboard item element. To obtain the underlying data for this element, use the DashboardItemMouseHitTestEventArgs.GetUnderlyingData method.


The DashboardItemDoubleClick event has the following limitations:


The following example demonstrates how to obtain underlying data corresponding to a particular visual element using the DashboardViewer's API.

In this example, the DashboardViewer.DashboardItemDoubleClick event is handled to obtain underlying data and display this data in the grid.

In the event handler, the DashboardItemMouseHitTestEventArgs.GetUnderlyingData method is called to obtain records from the dashboard's data source.


The complete sample project WinViewer - How to obtain a dashboard item's underlying data for a clicked visual element is available in the DevExpress Examples repository.

Imports System.Windows.Forms
Imports DevExpress.XtraEditors
Imports DevExpress.DashboardWin
Imports DevExpress.DashboardCommon

Namespace Dashboard_UnderlyingDataWin
    Partial Public Class Form1
        Inherits XtraForm

        Public Sub New()
        End Sub

        Private Sub dashboardViewer1_DashboardItemDoubleClick(ByVal sender As Object, _
                    ByVal e As DashboardItemMouseActionEventArgs) _
                Handles dashboardViewer1.DashboardItemDoubleClick
            Dim form As New XtraForm()
            form.Text = "Underlying Data"
            Dim underlyingData As DashboardUnderlyingDataSet = e.GetUnderlyingData()

            Dim grid As New DataGrid()
            grid.Parent = form
            grid.Dock = DockStyle.Fill
            If underlyingData IsNot Nothing Then
                grid.DataSource = underlyingData
                grid.CaptionText = "The grid has no data"
            End If
        End Sub
    End Class
End Namespace
See Also