Back to Devexpress

DashboardsApplicationBuilderExtensions.AddDashboards(IModuleBuilder<IWinApplicationBuilder>, Action<DashboardsOptions>) Method

expressappframework-devexpress-dot-expressapp-dot-win-dot-applicationbuilder-dot-dashboardsapplicationbuilderextensions-dot-adddashboards-x28-imodulebuilder-iwinapplicationbuilder-action-dashboardsoptions-x29.md

latest3.9 KB
Original Source

DashboardsApplicationBuilderExtensions.AddDashboards(IModuleBuilder<IWinApplicationBuilder>, Action<DashboardsOptions>) Method

Adds the Dashboards Module to your application.

Namespace : DevExpress.ExpressApp.Win.ApplicationBuilder

Assembly : DevExpress.ExpressApp.Dashboards.Win.v25.2.dll

NuGet Package : DevExpress.ExpressApp.Dashboards.Win

Declaration

csharp
public static IModuleBuilder<IWinApplicationBuilder> AddDashboards(
    this IModuleBuilder<IWinApplicationBuilder> builder,
    Action<DashboardsOptions> configureOptions = null
)
vb
<ExtensionAttribute>
Public Shared Function AddDashboards(
    builder As IModuleBuilder(Of IWinApplicationBuilder),
    configureOptions As Action(Of DashboardsOptions) = Nothing
) As IModuleBuilder(Of IWinApplicationBuilder)

Parameters

NameTypeDescription
builderIModuleBuilder<IWinApplicationBuilder>

Allows you to register and configure Modules in your application, and chain further Module registrations.

|

Optional Parameters

NameTypeDefaultDescription
configureOptionsAction<DashboardsOptions>null

Options that you can use to configure the Dashboards Module.

|

Returns

TypeDescription
IModuleBuilder<IWinApplicationBuilder>

Allows you to register and configure Modules in your application, and chain further Module registrations.

|

Remarks

The following example demonstrates how to use this method:

File : MySolution.Win\Startup.cs.

csharp
using DevExpress.ExpressApp.ApplicationBuilder;
using DevExpress.ExpressApp.Win.ApplicationBuilder;
// ...
public class ApplicationBuilder : IDesignTimeApplicationFactory {
    public static WinApplication BuildApplication(string connectionString) {
        var builder = WinApplication.CreateBuilder();
        builder.UseApplication<MySolutionWindowsFormsApplication>();
        builder.Modules
            // ...
            .AddDashboards(options => {
                options.DashboardDataType = typeof(DashboardData);
            })
        // ...
    }
    // ...
}

See Also

DashboardsApplicationBuilderExtensions Class

DashboardsApplicationBuilderExtensions Members

DevExpress.ExpressApp.Win.ApplicationBuilder Namespace