CustomDashboardItemControlCreatingEventArgs.CustomControlProvider Property

Gets or sets a custom control that displays a custom dashboard item.

Namespace: DevExpress.DashboardWin

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

Declaration

C#

public CustomControlProviderBase CustomControlProvider { get; set; }

VB.NET

Public Property CustomControlProvider As CustomControlProviderBase

Property Value

Type	Description
CustomControlProviderBase	A custom control that displays a custom dashboard item.

Remarks

Assign a CustomControlProviderBase class descendant to the CustomControlProvider property to display a custom dashboard item in a dashboard when you handle one of the following events:

• DashboardViewer.CustomDashboardItemControlCreating
• DashboardDesigner.CustomDashboardItemControlCreating
• IDashboardControl.CustomDashboardItemControlCreating

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the CustomControlProvider 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#L30

if (e.MetadataType == typeof(HelloWorldItemMetadata))
    e.CustomControlProvider = new HelloWorldItemProvider();
if (e.MetadataType == typeof(SimpleTableMetadata))

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#L27

If e.MetadataType Is GetType(HelloWorldItemMetadata) Then
    e.CustomControlProvider = New HelloWorldItemProvider()
End If