CustomDashboardItemControlCreatingEventArgs.MetadataType Property

Gets a custom item’s metadata type.

Namespace: DevExpress.DashboardWin

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

NuGet Package: DevExpress.Win.Dashboard

Declaration

C#

public Type MetadataType { get; }

VB.NET

Public ReadOnly Property MetadataType As Type

Property Value

Type	Description
Type	A CustomItemMetadata object.

Remarks

A metadata type is stored in the CustomItemMetadataTypes collection. It corresponds to a class derived from CustomItemMetadata.

Related GitHub Examples

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

void OnCustomDashboardItemControlCreating(object sender, CustomDashboardItemControlCreatingEventArgs e) {
    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#L29

private void DashboardDesigner1_CustomDashboardItemControlCreating(object sender, DevExpress.DashboardWin.CustomDashboardItemControlCreatingEventArgs e) {
    if (e.MetadataType == typeof(HelloWorldItemMetadata))
        e.CustomControlProvider = new HelloWorldItemProvider();

VB.NET

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

Dim dashboardControl As IDashboardControl = DirectCast(sender, IDashboardControl)
If e.MetadataType Is GetType(TreeListItemMetadata) Then
    e.CustomControlProvider = New TreeListItemControlProvider(TryCast(dashboardControl.Dashboard.Items(e.DashboardItemName), CustomDashboardItem(Of TreeListItemMetadata)))

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

Private Sub DashboardDesigner1_CustomDashboardItemControlCreating(ByVal sender As Object, ByVal e As DevExpress.DashboardWin.CustomDashboardItemControlCreatingEventArgs) Handles dashboardDesigner1.CustomDashboardItemControlCreating
    If e.MetadataType Is GetType(HelloWorldItemMetadata) Then
        e.CustomControlProvider = New HelloWorldItemProvider()