DashboardViewer.UpdateDashboardItemCaption(String) Method

Fires the CustomizeDashboardItemCaption event that allows you to customize the dashboard item caption content.

Namespace: DevExpress.DashboardWin

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

Declaration

C#

public void UpdateDashboardItemCaption(
    string dashboardItemName
)

VB.NET

Public Sub UpdateDashboardItemCaption(
    dashboardItemName As String
)

Parameters

Name	Type	Description
dashboardItemName	String	A String that is the dashboard item name accessible using the ComponentName property.

Example

The following code snippets demonstrate how to load data in the Dashboard designer on demand when all required filters are set. For this, the Show Data button is created in the DashboardDesigner.CustomizeDashboardTitle event handler.

DesignerForm1.cs

using DevExpress.DashboardWin;
using System;
using System.Linq;

namespace CustomShowDataExample
{
    public partial class DesignerForm1 : DevExpress.XtraBars.Ribbon.RibbonForm
    {
        public DesignerForm1()
        {
            InitializeComponent();
            dashboardDesigner.CustomizeDashboardTitle += DashboardDesigner_CustomizeDashboardTitle;
            dashboardDesigner.LoadDashboard(@"..\..\Dashboards\dashboard1.xml");
        }

        #region #CustomizeDashboardTitle
        private void DashboardDesigner_CustomizeDashboardTitle(object sender, CustomizeDashboardTitleEventArgs e)
        {
            DevExpress.Data.IParameter showDataParameter = dashboardDesigner.Parameters.FirstOrDefault(p => p.Name == "ShowData");
            if (showDataParameter != null)
            {
                bool showData = (bool)showDataParameter.Value;
                DashboardToolbarItem showDataItem = new DashboardToolbarItem(showData, "Select states in the State list box and click this button to display data",
                    new Action<DashboardToolbarItemClickEventArgs>((args) => {
                        showDataParameter.Value = !showData;
                    }));
                showDataItem.Caption = "Show Data";
                showDataItem.SvgImage = svgImageCollection1[0];
                e.Items.Insert(0, showDataItem);
            }
        }
        #endregion #CustomizeDashboardTitle
    }
}

VB.NET

Imports DevExpress.DashboardWin
Imports System
Imports System.Linq

Namespace CustomShowDataExample
    Partial Public Class DesignerForm1
        Inherits DevExpress.XtraBars.Ribbon.RibbonForm

        Public Sub New()
            InitializeComponent()
            AddHandler dashboardDesigner.CustomizeDashboardTitle, AddressOf DashboardDesigner_CustomizeDashboardTitle
            dashboardDesigner.LoadDashboard("..\..\Dashboards\dashboard1.xml")
        End Sub

        #Region "#CustomizeDashboardTitle"
        Private Sub DashboardDesigner_CustomizeDashboardTitle(ByVal sender As Object, ByVal e As CustomizeDashboardTitleEventArgs)
            Dim showDataParameter As DevExpress.Data.IParameter = dashboardDesigner.Parameters.FirstOrDefault(Function(p) p.Name = "ShowData")
            If showDataParameter IsNot Nothing Then
                Dim showData As Boolean = DirectCast(showDataParameter.Value, Boolean)
                Dim showDataItem As DashboardToolbarItem = New DashboardToolbarItem(showData, "Select states in the State list box and click this button to display data", New Action(Of DashboardToolbarItemClickEventArgs)(Sub(args)
                    showDataParameter.Value = Not showData
                End Sub))
                showDataItem.Caption = "Show Data"
                showDataItem.SvgImage = svgImageCollection1(0)
                e.Items.Insert(0, showDataItem)
            End If
        End Sub
        #End Region ' #CustomizeDashboardTitle
    End Class
End Namespace

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the UpdateDashboardItemCaption(String) method.

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-customize-title-and-item-captions/CS/CustomizeDashboardItemCaptionExample/ViewerForm1.cs#L113

foreach (DashboardItem i in dashboardViewer.Dashboard.Items) {
    dashboardViewer.UpdateDashboardItemCaption(i.ComponentName);
}

VB.NET

winforms-dashboard-customize-title-and-item-captions/VB/CustomizeDashboardItemCaptionExample/ViewerForm1.vb#L115

For Each i As DashboardItem In dashboardViewer.Dashboard.Items
    dashboardViewer.UpdateDashboardItemCaption(i.ComponentName)
Next i

Implements

UpdateDashboardItemCaption(String)