How to: Open a Detail View When the Grid Row is Clicked in the Dashboard

• Mar 28, 2018
• 8 minutes to read

This topic describes how to invoke a Detail View when a user clicks a row in the GridDashboardItem created using the Dashboards Module. In the invoked Detail View, a user can view or edit a business object corresponding to the clicked row.

WinForms Example

• Add a key property to the hidden measures of a Dashboard and set its summary type to Min or Max. The key property in this example is Oid.

  

• Add a View Controller to the WinForms module project.
• Access the WinDashboardViewerViewItem, as described in the How to: Access the Dashboard Control topic.
• In the ViewItem.ControlCreated event handler, subscribe to the DashboardViewer.DashboardItemControlCreated event.
• In the DashboardItemControlCreated event handler, access the DashboardViewer and subscribe to the DashboardViewer.DashboardItemDoubleClick event.
• In the DashboardItemDoubleClick event handler, get the key property value using the DashboardItemMouseActionEventArgs arguments.
• Add a ParametrizedAction to the Controller and force its execution in the DashboardItemDoubleClick event handler. The Action in the example is invisible because its category (“Dashboard”) does not match any existing Action Container. However, you still can execute it in code using the DoExecute method.
• In the ParametrizedAction.Execute event handler, create a new Object Space and find the clicked object using the IObjectSpace.FindObject method.
• Pass the found object to the XafApplication.CreateDetailView method to create a Detail View.
• Pass the created Detail View to the ShowViewParameters.CreatedView event argument to display it.

ASP.NET Example

• Add a key property to the hidden measures of a Dashboard and set its summary type to Min or Max. The key property in this example is Oid.

  

• Add a View Controller to the ASP.NET module project.
• Access the WebDashboardViewerViewItem, as described in the How to: Access the Dashboard Control topic.
• Add a handler to the client-side ASPxClientDashboard.ItemClick event.
• In this event handler, get the key property value using the ASPxClientDashboardItemClickEventArgs arguments.
• Generate a callback on the client side (in the ASPxClientDashboard item click handler) and process it on the server side (see How to: Raise XAF Callbacks from Client-Side Events and Process these Callbacks on Server).
• Add a ParametrizedAction to the Controller and force its execution in the IXafCallbackHandler.ProcessAction method implementation. The Action in the example is invisible because its category (“Dashboard”) does not match any existing Action Container. However, you still can execute it in code using the DoExecute method.
• In the ParametrizedAction.Execute event handler, create a new Object Space and find the clicked object using the IObjectSpace.FindObject method.
• Pass the found object to the XafApplication.CreateDetailView method to create a Detail View.
• Pass the created Detail View to the ShowViewParameters.CreatedView event argument to display it.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/xaf-win-web-open-detail-view-when-grid-row-is-clicked-in-the-dashboard.

WinShowDetailViewFromDashboardController.cs

using DevExpress.DashboardCommon;
using DevExpress.DashboardCommon.ViewerData;
using DevExpress.DashboardWin;
using DevExpress.Data.Filtering;
using DevExpress.ExpressApp;
using DevExpress.ExpressApp.Actions;
using DevExpress.ExpressApp.Dashboards.Win;
using DevExpress.Persistent.Base;
using ShowDetailViewFromDashboard.Module.BusinessObjects;
using System;
using System.Linq;

namespace ShowDetailViewFromDashboard.Module.Win.Controllers
{
    public class WinShowDetailViewFromDashboardController : ObjectViewController<DetailView, IDashboardData>
    {
        private ParametrizedAction openDetailViewAction;

        protected override void OnActivated()
        {
            base.OnActivated();
            WinDashboardViewerViewItem dashboardViewerViewItem = View.FindItem("DashboardViewer") as WinDashboardViewerViewItem;
            if (dashboardViewerViewItem != null)
            {
                if (dashboardViewerViewItem.Viewer != null)
                {
                    dashboardViewerViewItem.Viewer.DashboardItemDoubleClick += Viewer_DashboardItemDoubleClick;
                }
                dashboardViewerViewItem.ControlCreated += DashboardViewerViewItem_ControlCreated;
            }
        }

        private void DashboardViewerViewItem_ControlCreated(object sender, EventArgs e)
        {
            WinDashboardViewerViewItem dashboardViewerViewItem = sender as WinDashboardViewerViewItem;
            dashboardViewerViewItem.Viewer.DashboardItemDoubleClick += Viewer_DashboardItemDoubleClick;
        }
        private bool IsGridDashboardItem(Dashboard dashboard, string dashboardItemName)
        {
            DashboardItem dashboardItem = dashboard.Items.SingleOrDefault(item => item.ComponentName == dashboardItemName);
            return dashboardItem is GridDashboardItem;
        }
        private static string GetOid(DashboardItemMouseActionEventArgs e)
        {
            MultiDimensionalData data = e.Data.GetSlice(e.GetAxisPoint());
            MeasureDescriptor descriptor = data.GetMeasures().SingleOrDefault(item => item.DataMember == "Oid");
            MeasureValue measureValue = data.GetValue(descriptor);
            return measureValue.Value.ToString();
        }
        private void Viewer_DashboardItemDoubleClick(object sender, DashboardItemMouseActionEventArgs e)
        {
            Dashboard dashboard = ((DashboardViewer)sender).Dashboard;

            if (IsGridDashboardItem(dashboard, e.DashboardItemName) &&
                openDetailViewAction.Enabled && openDetailViewAction.Active)
            {
                openDetailViewAction.DoExecute(GetOid(e));
            }
        }

        private void OpenDetailViewAction_Execute(object sender, ParametrizedActionExecuteEventArgs e)
        {
            IObjectSpace objectSpace = Application.CreateObjectSpace(typeof(Contact));
            Contact contact = objectSpace.FindObject<Contact>(new BinaryOperator("Oid", e.ParameterCurrentValue.ToString()));
            if (contact != null)
            {
                e.ShowViewParameters.CreatedView = Application.CreateDetailView(objectSpace, contact, View);
            }
        }

        protected override void OnDeactivated()
        {
            WinDashboardViewerViewItem dashboardViewerViewItem = View.FindItem("DashboardViewer") as WinDashboardViewerViewItem;
            if (dashboardViewerViewItem != null)
            {
                dashboardViewerViewItem.ControlCreated -= DashboardViewerViewItem_ControlCreated;
            }
            base.OnDeactivated();
        }
        public WinShowDetailViewFromDashboardController()
        {
            openDetailViewAction = new ParametrizedAction(this, "Dashboard_OpenDetailView", "Dashboard", typeof(string));
            openDetailViewAction.Caption = "OpenDetailView";
            openDetailViewAction.SelectionDependencyType = SelectionDependencyType.RequireSingleObject;
            openDetailViewAction.Execute += OpenDetailViewAction_Execute;
        }
    }
}

WebShowDetailViewFromDashboardController.cs

using DevExpress.DashboardWeb;
using DevExpress.Data.Filtering;
using DevExpress.ExpressApp;
using DevExpress.ExpressApp.Actions;
using DevExpress.ExpressApp.Dashboards.Web;
using DevExpress.ExpressApp.Web;
using DevExpress.ExpressApp.Web.Templates;
using DevExpress.Persistent.Base;
using ShowDetailViewFromDashboard.Module.BusinessObjects;
using System;

namespace ShowDetailViewFromDashboard.Module.Web.Controllers
{
    public class WebShowDetailViewFromDashboardController : ObjectViewController<DetailView, IDashboardData>, IXafCallbackHandler
    {
        private const string HandlerName = "WebShowDetailViewFromDashboardController";
        private ParametrizedAction openDetailViewAction;

        protected override void OnActivated()
        {
            base.OnActivated();
            WebDashboardViewerViewItem dashboardViewerViewItem = View.FindItem("DashboardViewer") as WebDashboardViewerViewItem;
            if (dashboardViewerViewItem != null)
            {
                if (dashboardViewerViewItem.DashboardDesigner != null)
                {
                    CustomizeDashboardViewer(dashboardViewerViewItem.DashboardDesigner);
                }
                dashboardViewerViewItem.ControlCreated += DashboardViewerViewItem_ControlCreated;
            }
        }
        private void DashboardViewerViewItem_ControlCreated(object sender, EventArgs e)
        {
            WebDashboardViewerViewItem dashboardViewerViewItem = sender as WebDashboardViewerViewItem;
            CustomizeDashboardViewer(dashboardViewerViewItem.DashboardDesigner);
        }
        private void CustomizeDashboardViewer(ASPxDashboard dashboardControl)
        {
            XafCallbackManager callbackManager = ((ICallbackManagerHolder)WebWindow.CurrentRequestPage).CallbackManager;
            callbackManager.RegisterHandler(HandlerName, this);
            string widgetScript = @"function getOid(s, e) {{
                                        function findMeasure(measure) {{
                                            return measure.DataMember === 'Oid';
                                        }}
                                        if (e.ItemName.includes('gridDashboardItem')) {{
                                             var itemData = e.GetData(),
                                                dataSlice = itemData.GetSlice(e.GetAxisPoint()),
                                                oidMeasure = dataSlice.GetMeasures().find(findMeasure).Id,
                                                measureValue = dataSlice.GetMeasureValue(oidMeasure);
                                                {0}
                                        }}
                                    }}";
            dashboardControl.ClientSideEvents.ItemClick = string.Format(widgetScript, callbackManager.GetScript(HandlerName, "measureValue.GetValue()"));
        }
        public void ProcessAction(string parameter)
        {
            openDetailViewAction.DoExecute(parameter);
        }
        private void OpenDetailViewAction_Execute(object sender, ParametrizedActionExecuteEventArgs e)
        {
            IObjectSpace objectSpace = Application.CreateObjectSpace(typeof(Contact));
            Contact contact = objectSpace.FindObject<Contact>(new BinaryOperator("Oid", e.ParameterCurrentValue.ToString()));
            if (contact != null)
            {
                e.ShowViewParameters.CreatedView = Application.CreateDetailView(objectSpace, contact, View);
            }
        }

        protected override void OnDeactivated()
        {
            WebDashboardViewerViewItem dashboardViewerViewItem = View.FindItem("DashboardViewer") as WebDashboardViewerViewItem;
            if (dashboardViewerViewItem != null)
            {
                dashboardViewerViewItem.ControlCreated -= DashboardViewerViewItem_ControlCreated;
            }
            base.OnDeactivated();
        }
        public WebShowDetailViewFromDashboardController()
        {
            openDetailViewAction = new ParametrizedAction(this, "Dashboard_OpenDetailView", "Dashboard", typeof(string));
            openDetailViewAction.Caption = "OpenDetailView";
            openDetailViewAction.SelectionDependencyType = SelectionDependencyType.RequireSingleObject;
            openDetailViewAction.Execute += OpenDetailViewAction_Execute;
        }
    }
}

WebShowDetailViewFromDashboardController.vb

Imports DevExpress.DashboardWeb
Imports DevExpress.Data.Filtering
Imports DevExpress.ExpressApp
Imports DevExpress.ExpressApp.Actions
Imports DevExpress.ExpressApp.Dashboards.Web
Imports DevExpress.ExpressApp.Web
Imports DevExpress.ExpressApp.Web.Templates
Imports DevExpress.Persistent.Base
Imports ShowDetailViewFromDashboard.Module.BusinessObjects
Imports System

Namespace ShowDetailViewFromDashboard.Module.Web.Controllers
    Public Class WebShowDetailViewFromDashboardController
        Inherits ObjectViewController(Of DetailView, IDashboardData)
        Implements IXafCallbackHandler

        Private Const HandlerName As String = "WebShowDetailViewFromDashboardController"
        Private openDetailViewAction As ParametrizedAction

        Protected Overrides Sub OnActivated()
            MyBase.OnActivated()
            Dim dashboardViewerViewItem As WebDashboardViewerViewItem = TryCast(View.FindItem("DashboardViewer"), WebDashboardViewerViewItem)
            If dashboardViewerViewItem IsNot Nothing Then
                If dashboardViewerViewItem.DashboardDesigner IsNot Nothing Then
                    CustomizeDashboardViewer(dashboardViewerViewItem.DashboardDesigner)
                End If
                AddHandler dashboardViewerViewItem.ControlCreated, AddressOf DashboardViewerViewItem_ControlCreated
            End If
        End Sub
        Private Sub DashboardViewerViewItem_ControlCreated(ByVal sender As Object, ByVal e As EventArgs)
            Dim dashboardViewerViewItem As WebDashboardViewerViewItem = TryCast(sender, WebDashboardViewerViewItem)
            CustomizeDashboardViewer(dashboardViewerViewItem.DashboardDesigner)
        End Sub
        Private Sub CustomizeDashboardViewer(ByVal dashboardControl As ASPxDashboard)
            Dim callbackManager As XafCallbackManager = DirectCast(WebWindow.CurrentRequestPage, ICallbackManagerHolder).CallbackManager
            callbackManager.RegisterHandler(HandlerName, Me)
            Dim widgetScript As String = <a>function getOid(s, e) {{
                                        function findMeasure(measure) {{
                                            return measure.DataMember === 'Oid';
                                        }}
                                        if (e.ItemName.includes('gridDashboardItem')) {{
                                             var itemData = e.GetData(),
                                                dataSlice = itemData.GetSlice(e.GetAxisPoint()),
                                                oidMeasure = dataSlice.GetMeasures().find(findMeasure).Id,
                                                measureValue = dataSlice.GetMeasureValue(oidMeasure);
                                                {0}
                                        }}
                                    }}</a>.Value
            dashboardControl.ClientSideEvents.ItemClick = String.Format(widgetScript, callbackManager.GetScript(HandlerName, "measureValue.GetValue()"))
        End Sub
        Public Sub ProcessAction(ByVal parameter As String) Implements IXafCallbackHandler.ProcessAction
            openDetailViewAction.DoExecute(parameter)
        End Sub
        Private Sub OpenDetailViewAction_Execute(ByVal sender As Object, ByVal e As ParametrizedActionExecuteEventArgs)
            Dim objectSpace As IObjectSpace = Application.CreateObjectSpace(GetType(Contact))
            Dim contact As Contact = objectSpace.FindObject(Of Contact)(New BinaryOperator("Oid", e.ParameterCurrentValue.ToString()))
            If contact IsNot Nothing Then
                e.ShowViewParameters.CreatedView = Application.CreateDetailView(objectSpace, contact, View)
            End If
        End Sub

        Protected Overrides Sub OnDeactivated()
            Dim dashboardViewerViewItem As WebDashboardViewerViewItem = TryCast(View.FindItem("DashboardViewer"), WebDashboardViewerViewItem)
            If dashboardViewerViewItem IsNot Nothing Then
                RemoveHandler dashboardViewerViewItem.ControlCreated, AddressOf DashboardViewerViewItem_ControlCreated
            End If
            MyBase.OnDeactivated()
        End Sub
        Public Sub New()
            openDetailViewAction = New ParametrizedAction(Me, "Dashboard_OpenDetailView", "Dashboard", GetType(String))
            openDetailViewAction.Caption = "OpenDetailView"
            openDetailViewAction.SelectionDependencyType = SelectionDependencyType.RequireSingleObject
            AddHandler openDetailViewAction.Execute, AddressOf OpenDetailViewAction_Execute
        End Sub
    End Class
End Namespace

WinShowDetailViewFromDashboardController.vb

Imports DevExpress.DashboardCommon
Imports DevExpress.DashboardCommon.ViewerData
Imports DevExpress.DashboardWin
Imports DevExpress.Data.Filtering
Imports DevExpress.ExpressApp
Imports DevExpress.ExpressApp.Actions
Imports DevExpress.ExpressApp.Dashboards.Win
Imports DevExpress.Persistent.Base
Imports ShowDetailViewFromDashboard.Module.BusinessObjects
Imports System
Imports System.Linq

Namespace ShowDetailViewFromDashboard.Module.Win.Controllers
    Public Class WinShowDetailViewFromDashboardController
        Inherits ObjectViewController(Of DetailView, IDashboardData)

        Private openDetailViewAction As ParametrizedAction

        Protected Overrides Sub OnActivated()
            MyBase.OnActivated()
            Dim dashboardViewerViewItem As WinDashboardViewerViewItem = TryCast(View.FindItem("DashboardViewer"), WinDashboardViewerViewItem)
            If dashboardViewerViewItem IsNot Nothing Then
                If dashboardViewerViewItem.Viewer IsNot Nothing Then
                    AddHandler dashboardViewerViewItem.Viewer.DashboardItemDoubleClick, AddressOf Viewer_DashboardItemDoubleClick
                End If
                AddHandler dashboardViewerViewItem.ControlCreated, AddressOf DashboardViewerViewItem_ControlCreated
            End If
        End Sub

        Private Sub DashboardViewerViewItem_ControlCreated(ByVal sender As Object, ByVal e As EventArgs)
            Dim dashboardViewerViewItem As WinDashboardViewerViewItem = TryCast(sender, WinDashboardViewerViewItem)
            AddHandler dashboardViewerViewItem.Viewer.DashboardItemDoubleClick, AddressOf Viewer_DashboardItemDoubleClick
        End Sub
        Private Function IsGridDashboardItem(ByVal dashboard As Dashboard, ByVal dashboardItemName As String) As Boolean
            Dim dashboardItem As DashboardItem = dashboard.Items.SingleOrDefault(Function(item) item.ComponentName = dashboardItemName)
            Return TypeOf dashboardItem Is GridDashboardItem
        End Function
        Private Shared Function GetOid(ByVal e As DashboardItemMouseActionEventArgs) As String
            Dim data As MultiDimensionalData = e.Data.GetSlice(e.GetAxisPoint())
            Dim descriptor As MeasureDescriptor = data.GetMeasures().SingleOrDefault(Function(item) item.DataMember = "Oid")
            Dim measureValue As MeasureValue = data.GetValue(descriptor)
            Return measureValue.Value.ToString()
        End Function
        Private Sub Viewer_DashboardItemDoubleClick(ByVal sender As Object, ByVal e As DashboardItemMouseActionEventArgs)
            Dim dashboard As Dashboard = DirectCast(sender, DashboardViewer).Dashboard

            If IsGridDashboardItem(dashboard, e.DashboardItemName) AndAlso openDetailViewAction.Enabled.ResultValue AndAlso openDetailViewAction.Active.ResultValue Then
                openDetailViewAction.DoExecute(GetOid(e))
            End If
        End Sub

        Private Sub OpenDetailViewAction_Execute(ByVal sender As Object, ByVal e As ParametrizedActionExecuteEventArgs)
            Dim objectSpace As IObjectSpace = Application.CreateObjectSpace(GetType(Contact))
            Dim contact As Contact = objectSpace.FindObject(Of Contact)(New BinaryOperator("Oid", e.ParameterCurrentValue.ToString()))
            If contact IsNot Nothing Then
                e.ShowViewParameters.CreatedView = Application.CreateDetailView(objectSpace, contact, View)
            End If
        End Sub

        Protected Overrides Sub OnDeactivated()
            Dim dashboardViewerViewItem As WinDashboardViewerViewItem = TryCast(View.FindItem("DashboardViewer"), WinDashboardViewerViewItem)
            If dashboardViewerViewItem IsNot Nothing Then
                RemoveHandler dashboardViewerViewItem.ControlCreated, AddressOf DashboardViewerViewItem_ControlCreated
            End If
            MyBase.OnDeactivated()
        End Sub
        Public Sub New()
            openDetailViewAction = New ParametrizedAction(Me, "Dashboard_OpenDetailView", "Dashboard", GetType(String))
            openDetailViewAction.Caption = "OpenDetailView"
            openDetailViewAction.SelectionDependencyType = SelectionDependencyType.RequireSingleObject
            AddHandler openDetailViewAction.Execute, AddressOf OpenDetailViewAction_Execute
        End Sub
    End Class
End Namespace