CustomDashboardItem<T> Class

A custom dashboard item.

Namespace : DevExpress.DashboardCommon

Assembly : DevExpress.Dashboard.v25.2.Core.dll

NuGet Package : DevExpress.Dashboard.Core

Declaration

csharp

public class CustomDashboardItem<T> :
    CustomDashboardItem
    where T : CustomItemMetadata, new()

Public Class CustomDashboardItem(Of T As {CustomItemMetadata, New})
    Inherits CustomDashboardItem

Name	Description
T

A CustomItemMetadata class descendant.

A custom dashboard item allows you to embed any WinForms UI control into a dashboard. The following image illustrates a custom dashboard Funnel item:

Follow the steps below to create a custom dashboard item:

Declare a derived metadata class to configure the data item structure in a custom dashboard item and create a binding panel. The CustomDashboardItem<T>.Metadata property allows you to access the created metadata object.
Register a new metadata type. Call the CustomItemMetadataTypes.Register<T>() method before the main application form is created. Pass a new metadata type to the method. This allows the dashboard control to read custom item data from a dashboard.
To display a custom dashboard item, configure a custom control in a CustomControlProviderBase class descendant.
To visualize a custom item in a dashboard, handle the DashboardDesigner.CustomDashboardItemControlCreating, DashboardViewer.CustomDashboardItemControlCreating, or IDashboardControl.CustomDashboardItemControlCreating event and pass the CustomControlProviderBase class descendant to the CustomDashboardItemControlCreatingEventArgs.CustomControlProvider property.

Refer to the following article for more information about custom items: Custom Items Overview.