dashboard-devexpress-dot-dashboardwin-dot-dashboarddesigner-d981b23c.md
Allows you to access underlying WinForms controls.
Namespace : DevExpress.DashboardWin
Assembly : DevExpress.Dashboard.v25.2.Win.dll
NuGet Package : DevExpress.Win.Dashboard
public event DashboardItemControlCreatedEventHandler DashboardItemControlCreated
Public Event DashboardItemControlCreated As DashboardItemControlCreatedEventHandler
The DashboardItemControlCreated event's data class is DashboardItemControlEventArgs. The following properties provide information specific to this event:
| Property | Description |
|---|---|
| CardControl | Gets an underlying Card control. |
| ChartContext | Gets the chart context. |
| 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. |
| GaugeContext | Gets the gauge context. |
| GaugeControl | Gets an underlying gauge control. |
| GridContext | Gets the grid context. |
| 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. |
The DashboardDesigner uses DevExpress WinForms controls to visualize data within dashboard items. The DashboardDesigner.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
| | --- | --- | --- | |
|
|
DashboardItemControlEventArgs.GridControl
| |
|
|
DashboardItemControlEventArgs.ChartControl
| |
|
|
DashboardItemControlEventArgs.GaugeControl
| |
|
|
DashboardItemControlEventArgs.CardControl
| |
|
|
DashboardItemControlEventArgs.PivotGridControl
| |
|
|
DashboardItemControlEventArgs.MapControl
| |
|
|
DashboardItemControlEventArgs.TreeMapControl
| |
|
|
DashboardItemControlEventArgs.RichEditControl
| |
|
|
DashboardItemControlEventArgs.PictureEdit
| |
|
|
DashboardItemControlEventArgs.DateFilterControl
|
You can change the control setting or handle its events. To subscribe/unsubscribe from control events, use the DashboardItemControlCreated /DashboardDesigner.DashboardItemBeforeControlDisposed events, respectively.
Note
The dashboard item is re-created when you maximize / restore the item. All events connected with a dashboard item life cycle (such as DashboardItemControlCreated, DashboardItemControlUpdated, etc.) are fired again.
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:
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 DirectCast(e.Value, Decimal) < 2000 Then
e.Value = "Too low to show"
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("Segoe Script", 10)
End If
If e.DashboardItemName = "chartDashboardItem1" Then
Dim chartControl As ChartControl = e.ChartControl
CType(chartControl.Diagram, XYDiagram).Panes(0).BackColor = Color.Orange
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
using System.Drawing;
using DevExpress.XtraEditors;
using DevExpress.DashboardWin;
using DevExpress.XtraGrid.Views.Grid;
using DevExpress.XtraCharts;
using DevExpress.XtraPivotGrid;
namespace Dashboard_ControlAccess {
public partial class Form1 : XtraForm {
public Form1() {
InitializeComponent();
dashboardViewer1.LoadDashboard(@"..\..\Data\Dashboard.xml");
}
private void dashboardViewer1_DashboardItemControlCreated(object sender,
DashboardItemControlEventArgs e) {
if (e.DashboardItemName == "pivotDashboardItem1") {
PivotGridControl pivotGridControl = e.PivotGridControl;
pivotGridControl.CustomCellValue += pivotGridControl_CustomCellValue;
}
}
void pivotGridControl_CustomCellValue(object sender, PivotCellValueEventArgs e) {
if (e.Value != null && (decimal)e.Value < 2000)
e.Value = "Too low to show";
}
private void dashboardViewer1_DashboardItemControlUpdated(object sender,
DashboardItemControlEventArgs e) {
if (e.DashboardItemName == "gridDashboardItem1") {
GridView gridView = e.GridControl.MainView as GridView;
gridView.Appearance.Row.Font = new Font("Segoe Script", 10);
}
if (e.DashboardItemName == "chartDashboardItem1") {
ChartControl chartControl = e.ChartControl;
((XYDiagram)chartControl.Diagram).Panes[0].BackColor = Color.Orange;
}
}
private void dashboardViewer1_DashboardItemBeforeControlDisposed(object sender,
DashboardItemControlEventArgs e) {
if (e.DashboardItemName == "pivotDashboardItem1") {
PivotGridControl pivotGridControl = e.PivotGridControl;
pivotGridControl.CustomCellValue -= pivotGridControl_CustomCellValue;
}
}
}
}
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.
using DevExpress.DashboardCommon.ViewerData;
using DevExpress.DashboardWin;
using DevExpress.XtraCharts;
namespace TotalsInChartsExample
{
public partial class Form1 : DevExpress.XtraEditors.XtraForm
{
public Form1() {
InitializeComponent();
dashboardViewer1.DashboardItemControlUpdated += Viewer_DashboardItemControlUpdated;
dashboardViewer1.CalculateHiddenTotals = true;
dashboardViewer1.DashboardSource = typeof(Dashboards.Dashboard1);
}
private void Viewer_DashboardItemControlUpdated(object sender, 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);
}
}
}
}
}
}
Imports DevExpress.DashboardCommon.ViewerData
Imports DevExpress.DashboardWin
Imports DevExpress.XtraCharts
Namespace TotalsInChartsExample
Partial Public Class Form1
Inherits DevExpress.XtraEditors.XtraForm
Public Sub New()
InitializeComponent()
AddHandler dashboardViewer1.DashboardItemControlUpdated, AddressOf Viewer_DashboardItemControlUpdated
dashboardViewer1.CalculateHiddenTotals = True
dashboardViewer1.DashboardSource = GetType(Dashboards.Dashboard1)
End Sub
Private Sub Viewer_DashboardItemControlUpdated(ByVal sender As Object, ByVal e As DashboardItemControlEventArgs)
If e.DashboardItemName = "pieDashboardItem1" Then
Dim viewer = DirectCast(sender, DashboardViewer)
Dim chart = e.ChartControl
Dim data = viewer.GetItemData(e.DashboardItemName)
Dim measure = data.GetMeasures()(0)
For Each series As Series In chart.Series
Dim axisPoint = TryCast(series.Tag, AxisPoint)
If axisPoint IsNot Nothing Then
Dim total = data.GetSlice(axisPoint).GetValue(measure).DisplayText
Dim view = TryCast(series.View, PieSeriesView)
If view IsNot Nothing Then
view.Titles(0).Text = String.Format("{0} - {1}", series.Name, total)
End If
End If
Next series
End If
End Sub
End Class
End Namespace
See Also