DashboardsModule.AddDashboardDataFromResources<T>(IObjectSpace, String, Assembly, String) Method

Creates a dashboard data object from the specified XML resource file if there is no dashboard data with the specified title parameter in the database.

Namespace: DevExpress.ExpressApp.Dashboards

Assembly: DevExpress.ExpressApp.Dashboards.v24.1.dll

NuGet Package: DevExpress.ExpressApp.Dashboards

Declaration

C#

public static T AddDashboardDataFromResources<T>(
    IObjectSpace objectSpace,
    string title,
    Assembly assembly,
    string embeddedResourceName
)
    where T : IDashboardData

VB.NET

Public Shared Function AddDashboardDataFromResources(Of T As IDashboardData)(
    objectSpace As IObjectSpace,
    title As String,
    assembly As Assembly,
    embeddedResourceName As String
) As T

Parameters

Name	Type	Description
objectSpace	IObjectSpace	An IObjectSpace object that specifies the Object Space.
title	String	A string specifying the dashboard title.
assembly	Assembly	An Assembly specifying the assembly which contains the dashboard configuration as an embedded resource.
embeddedResourceName	String	A string specifying the embedded resource name which contains the dashboard configuration in XML format.

Type Parameters

Name
T

Returns

Type	Description
T	A dashboard data object.

Remarks

To recreate the predefined dashboard, first delete the Dashboard in the DashboardData ListView and then restart the application.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the AddDashboardDataFromResources<T>(IObjectSpace, String, Assembly, String) method.

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#

xaf-how-to-show-a-custom-form-as-the-winforms-dashboard-designer/CS/CustomDashboardDesignerForm.Module/DatabaseUpdate/Updater.cs#L55

Assembly assembly = Assembly.GetExecutingAssembly();
DashboardsModule.AddDashboardDataFromResources<DashboardData>(ObjectSpace, "Contacts", assembly, "CustomDashboardDesignerForm.Module.Dashboards.Contacts.xml");

xaf-win-web-open-detail-view-when-grid-row-is-clicked-in-the-dashboard/CS/ShowDetailViewFromDashboard.Module/DatabaseUpdate/Updater.cs#L50

Assembly assembly = Assembly.GetExecutingAssembly();
DashboardsModule.AddDashboardDataFromResources<DashboardData>(ObjectSpace, "Contacts", assembly, "ShowDetailViewFromDashboard.Module.Dashboards.Contacts.xml");

VB.NET

xaf-how-to-show-a-custom-form-as-the-winforms-dashboard-designer/VB/CustomDashboardDesignerForm.Module/DatabaseUpdate/Updater.vb#L52

Dim assembly As System.Reflection.Assembly = System.Reflection.Assembly.GetExecutingAssembly()
DashboardsModule.AddDashboardDataFromResources(Of DashboardData)(ObjectSpace, "Contacts", assembly, "CustomDashboardDesignerForm.Module.Dashboards.Contacts.xml")

xaf-win-web-open-detail-view-when-grid-row-is-clicked-in-the-dashboard/VB/ShowDetailViewFromDashboard.Module/DatabaseUpdate/Updater.vb#L52

Dim assembly As System.Reflection.Assembly = System.Reflection.Assembly.GetExecutingAssembly()
DashboardsModule.AddDashboardDataFromResources(Of DashboardData)(ObjectSpace, "Contacts", assembly, "Contacts.xml")