DashboardViewer.UpdateDashboardItemCaption(String) Method

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

Namespace: DevExpress.DashboardWin

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

NuGet Packages: DevExpress.Win.Dashboard, DevExpress.WindowsDesktop.Win.Dashboard

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.

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

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

VB.NET

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

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

Implements

UpdateDashboardItemCaption(String)