CustomDashboardItem<T> Class
A custom dashboard item.
Namespace: DevExpress.DashboardCommon
Assembly: DevExpress.Dashboard.v21.1.Core.dll
NuGet Package: DevExpress.Dashboard.Core
Declaration
public class CustomDashboardItem<T> :
CustomDashboardItem
where T : CustomItemMetadata, new()Type Parameters
| Name | Description |
|---|---|
| T | A CustomItemMetadata class descendant. |
Remarks
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
CustomControlProviderBaseclass descendant to the CustomDashboardItemControlCreatingEventArgs.CustomControlProvider property.
Refer to the following article for more information about custom items: Custom Items Overview.