DashboardViewer.DashboardItemControlUpdated Event
Allows you to access underlying WinForms controls.
Namespace: DevExpress.DashboardWin
Assembly: DevExpress.Dashboard.v19.1.Win.dll
Declaration
Event Data
The DashboardItemControlUpdated event's data class is DashboardItemControlEventArgs. The following properties provide information specific to this event:
| Property | Description |
|---|---|
| CardControl | Gets an underlying Card control. |
| ChartControl | Gets an underlying chart control. |
| DashboardItemName | Gets the component name of the dashboard item for which the event was raised. |
| DateFilterControl | Gets an underlying date filter control. |
| GaugeControl | Gets an underlying gauge control. |
| GridControl | Gets an underlying grid control. |
| MapControl | Gets an underlying map control. |
| PictureEdit | Gets an underlying picture edit control. |
| PivotGridControl | Gets an underlying PivotGridControl. |
| RichEditControl | Gets an underlying RichEdit control. |
| TreeMapControl | Gets an underlying TreeMap control. |
Remarks
The WinForms Viewer uses DevExpress WinForms controls to visualize data within dashboard items. The DashboardItemControlUpdated event allows you to access these controls and customize their settings if necessary.
The DashboardItemControlEventArgs.DashboardItemName property returns the component name of the dashboard item to be customized. Use the following properties to access the corresponding underlying controls.
Dashboard Item | Control | Property |
|---|---|---|
You can change the control setting or handle its events. To subscribe/unsubscribe from control events, use the DashboardViewer.DashboardItemControlCreated/DashboardViewer.DashboardItemBeforeControlDisposed events, respectively.
To learn more, see Access to Underlying Controls.
Note
The dashboard item is re-created when you maximize / restore the item. All events connected with dashboard item life cycle (such as DashboardItemControlCreated, DashboardItemControlUpdated, etc.) are fired again.
Examples
The following example demonstrates how to customize controls used to visualize data within dashboard items at runtime using DashboardViewer‘s API.
In this example, the following options are changed:
- The font of data rows’ text is changed in the underlying grid control in the
DashboardViewer.DashboardItemControlUpdatedevent handler. - The background color of the chart’s pane is changed in the
DashboardViewer.DashboardItemControlUpdatedevent handler. - Values of data cells in the underlying pivot grid control are customized using the PivotGridControl.CustomCellValue event. Subscription and unsubscription to/from the CustomCellValue event are performed in the DashboardViewer.DashboardItemControlCreated and DashboardViewer.DashboardItemBeforeControlDisposed event handlers respectively.
Note
A complete sample project is available at https://github.com/DevExpress-Examples/how-to-access-api-of-underlying-controls-in-the-winforms-viewer-t197114.
Imports System.Drawing
Imports DevExpress.XtraEditors
Imports DevExpress.DashboardWin
Imports DevExpress.XtraGrid.Views.Grid
Imports DevExpress.XtraCharts
Imports DevExpress.XtraPivotGrid
Namespace Dashboard_ControlAccess
Partial Public Class Form1
Inherits XtraForm
Public Sub New()
InitializeComponent()
dashboardViewer1.LoadDashboard("..\..\Data\Dashboard.xml")
End Sub
Private Sub dashboardViewer1_DashboardItemControlCreated(ByVal sender As Object, _
ByVal e As DashboardItemControlEventArgs) _
Handles dashboardViewer1.DashboardItemControlCreated
If e.DashboardItemName = "pivotDashboardItem1" Then
Dim pivotGridControl As PivotGridControl = e.PivotGridControl
AddHandler pivotGridControl.CustomCellValue, AddressOf pivotGridControl_CustomCellValue
End If
End Sub
Private Sub pivotGridControl_CustomCellValue(ByVal sender As Object, _
ByVal e As PivotCellValueEventArgs)
If e.Value IsNot Nothing AndAlso CDec(e.Value) < 2000 Then
e.Value = 0
End If
End Sub
Private Sub dashboardViewer1_DashboardItemControlUpdated(ByVal sender As Object, _
ByVal e As DashboardItemControlEventArgs) _
Handles dashboardViewer1.DashboardItemControlUpdated
If e.DashboardItemName = "gridDashboardItem1" Then
Dim gridView As GridView = TryCast(e.GridControl.MainView, GridView)
gridView.Appearance.Row.Font = New Font("Arial", 10)
End If
If e.DashboardItemName = "chartDashboardItem1" Then
Dim chartControl As ChartControl = e.ChartControl
CType(chartControl.Diagram, XYDiagram).Panes(0).BackColor = Color.AliceBlue
End If
End Sub
Private Sub dashboardViewer1_DashboardItemBeforeControlDisposed(ByVal sender As Object, _
ByVal e As DashboardItemControlEventArgs) _
Handles dashboardViewer1.DashboardItemBeforeControlDisposed
If e.DashboardItemName = "pivotDashboardItem1" Then
Dim pivotGridControl As PivotGridControl = e.PivotGridControl
RemoveHandler pivotGridControl.CustomCellValue,
AddressOf pivotGridControl_CustomCellValue
End If
End Sub
End Class
End Namespace
This example demonstrates how to access the underlying controls used to display the Pie Item and configure their settings to display the Total value in the title. Total values are calculated automatically if the CalculateHiddenTotals property is enabled. Use the DashboardViewer.GetItemData method to get the total value.
Note
A complete sample project is available at https://github.com/DevExpress-Examples/how-to-display-the-total-value-above-each-pie-chart.
using DevExpress.DashboardCommon.ViewerData;
using DevExpress.DashboardWin;
using DevExpress.XtraBars;
using DevExpress.XtraCharts;
using System.Linq;
namespace Viewer {
public partial class Form1 : DevExpress.XtraBars.Ribbon.RibbonForm {
public Form1() {
InitializeComponent();
dashboardViewer1.DashboardItemControlUpdated += Viewer_DashboardItemControlUpdated;
dashboardViewer1.CalculateHiddenTotals = true;
dashboardViewer1.LoadDashboard(@"..\..\Dashboards\dashboard1.xml");
}
private void Viewer_DashboardItemControlUpdated(object sender, DevExpress.DashboardWin.DashboardItemControlEventArgs e) {
if (e.DashboardItemName == "pieDashboardItem1") {
var viewer = (DashboardViewer)sender;
var chart = e.ChartControl;
var data = viewer.GetItemData(e.DashboardItemName);
var measure = data.GetMeasures()[0];
foreach (Series series in chart.Series) {
var axisPoint = series.Tag as AxisPoint;
if (axisPoint != null) {
var total = data.GetSlice(axisPoint).GetValue(measure).DisplayText;
var view = series.View as PieSeriesView;
if (view != null)
view.Titles[0].Text = string.Format("{0} - {1}", series.Name, total);
}
}
}
}
}
}
Related GitHub Examples
The following code snippets (auto-collected from DevExpress Examples) contain references to the DashboardItemControlUpdated event.
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.