CustomDashboardItemControlCreatingEventArgs.DashboardItemName Property

Gets the component name of the custom dashboard item.

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	The component name of the custom 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-custom-items-extension/CS/CustomItemExtension/CustomItems/SankeyChart/SankeyItemExtensionModule.cs#L36

    if(e.MetadataType == typeof(SankeyItemMetadata))
        e.CustomControlProvider = new SankeyItemControlProvider(dashboardControl.Dashboard.Items[e.DashboardItemName] as CustomDashboardItem<SankeyItemMetadata>);
}

winforms-dashboard-custom-items/CS/TutorialsCustomItems/Form1.cs#L34

    if (e.MetadataType == typeof(FunnelItemMetadata))
        e.CustomControlProvider = new FunnelItemControlProvider(dashboardDesigner1.Dashboard.Items[e.DashboardItemName] as CustomDashboardItem<FunnelItemMetadata>);
}

VB.NET

winforms-dashboard-custom-items-extension/VB/CustomItemExtension/CustomItems/TreeList/TreeListItemExtensionModule.vb#L38

If e.MetadataType Is GetType(TreeListItemMetadata) Then
    e.CustomControlProvider = New TreeListItemControlProvider(TryCast(dashboardControl.Dashboard.Items(e.DashboardItemName), CustomDashboardItem(Of TreeListItemMetadata)))
End If

winforms-dashboard-custom-items/VB/TutorialsCustomItems/Form1.vb#L33

If e.MetadataType Is GetType(FunnelItemMetadata) Then
    e.CustomControlProvider = New FunnelItemControlProvider(TryCast(dashboardDesigner1.Dashboard.Items(e.DashboardItemName), CustomDashboardItem(Of FunnelItemMetadata)))
End If