DashboardItemControlEventArgs.DashboardItemName Property

Gets the component name of the dashboard item for which the event was raised.

Namespace: DevExpress.DashboardWin

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

NuGet Package: DevExpress.Win.Dashboard

Declaration

C#

public string DashboardItemName { get; }

VB.NET

Public ReadOnly Property DashboardItemName As String

Property Value

Type	Description
String	A String that is the component name of the dashboard item.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the DashboardItemName property.

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.

C#

winforms-dashboard-access-api-of-underlying-controls/CS/Dashboard_ControlAccess/Form1.cs#L17

DashboardItemControlEventArgs e) {
if (e.DashboardItemName == "pivotDashboardItem1") {
    PivotGridControl pivotGridControl = e.PivotGridControl;

winforms-dashboard-custom-properties/CS/WinForms-Dashboard-Custom-Properties/Modules/GridFixedColumnModule.cs#L40

if(e.GridControl != null) {
    GridDashboardItem gridItem = designer.Dashboard.Items[e.DashboardItemName] as GridDashboardItem;
    gridItem.GridOptions.ColumnWidthMode = GridColumnWidthMode.AutoFitToContents;

winforms-dashboards-how-to-use-a-custom-format-for-axis-labels-in-the-chart-item/CS/DesignerSample/Form1.cs#L24

{
    switch (e.DashboardItemName)
    {

how-to-display-the-total-value-above-each-pie-chart/CS/TotalsInChartsExample/Form1.cs#L18

private void Viewer_DashboardItemControlUpdated(object sender, DashboardItemControlEventArgs e) {
    if (e.DashboardItemName == "pieDashboardItem1") {
        var viewer = (DashboardViewer)sender;

win-designer-pivot-as-master-filter/CS/DesignerSample/Form1.cs#L27

void OnDashboardItemControlCreated(object sender, DashboardItemControlEventArgs e) {
    if(e.DashboardItemName == "pivotDashboardItem1") {
        e.PivotGridControl.MouseDown += OnPivotGridControlMouseDown;

VB.NET

winforms-dashboard-access-api-of-underlying-controls/VB/Dashboard_ControlAccess/Form1.vb#L18

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

winforms-dashboard-custom-properties/VB/WinForms-Dashboard-Custom-Properties/Modules/GridFixedColumnModule.vb#L40

If e.GridControl IsNot Nothing Then
    Dim gridItem As GridDashboardItem = TryCast(designer.Dashboard.Items(e.DashboardItemName), GridDashboardItem)
    gridItem.GridOptions.ColumnWidthMode = GridColumnWidthMode.AutoFitToContents

winforms-dashboards-how-to-use-a-custom-format-for-axis-labels-in-the-chart-item/VB/DesignerSample/Form1.vb#L22

Private Sub dashboardDesigner1_DashboardItemControlCreated(ByVal sender As Object, ByVal e As DevExpress.DashboardWin.DashboardItemControlEventArgs) Handles dashboardDesigner1.DashboardItemControlCreated
    Select Case e.DashboardItemName
        '1. Chart with the Currency Format (Y Axis)

how-to-display-the-total-value-above-each-pie-chart/VB/TotalsInChartsExample/Form1.vb#L18

Private Sub Viewer_DashboardItemControlUpdated(ByVal sender As Object, ByVal e As DashboardItemControlEventArgs)
    If e.DashboardItemName = "pieDashboardItem1" Then
        Dim viewer = DirectCast(sender, DashboardViewer)

win-designer-pivot-as-master-filter/VB/DesignerSample/Form1.vb#L29

Private Sub OnDashboardItemControlCreated(ByVal sender As Object, ByVal e As DashboardItemControlEventArgs) Handles dashboardDesigner1.DashboardItemControlCreated
    If e.DashboardItemName = "pivotDashboardItem1" Then
        AddHandler e.PivotGridControl.MouseDown, AddressOf OnPivotGridControlMouseDown