Back to Devexpress

StartupExtensions.AddXafDashboards(IServiceCollection, Action<BlazorDashboardConfigurator, IServiceProvider>) Method

expressappframework-devexpress-dot-expressapp-dot-dashboards-dot-blazor-dot-startupextensions-dot-addxafdashboards-x28-iservicecollection-action-blazordashboardconfigurator-iserviceprovider-x29.md

latest4.1 KB
Original Source

StartupExtensions.AddXafDashboards(IServiceCollection, Action<BlazorDashboardConfigurator, IServiceProvider>) Method

Registers the required Dashboards Module services in the application’s IServiceCollection.

Namespace : DevExpress.ExpressApp.Dashboards.Blazor

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

NuGet Package : DevExpress.ExpressApp.Dashboards.Blazor

Declaration

csharp
public static IServiceCollection AddXafDashboards(
    this IServiceCollection services,
    Action<BlazorDashboardConfigurator, IServiceProvider> configure = null
)
vb
<ExtensionAttribute>
Public Shared Function AddXafDashboards(
    services As IServiceCollection,
    configure As Action(Of BlazorDashboardConfigurator, IServiceProvider) = Nothing
) As IServiceCollection

Parameters

NameTypeDescription
servicesIServiceCollection

The collection of services registered in your application.

|

Optional Parameters

NameTypeDefaultDescription
configureAction<BlazorDashboardConfigurator, IServiceProvider>null

A delegate that allows you to customize the BlazorDashboardConfigurator settings.

|

Returns

TypeDescription
IServiceCollection

The collection of services registered in your application. Allows you to chain further service registrations.

|

Remarks

Call this method in the Startup.ConfigureServices method when you add the Dashboards Module to your ASP.NET Core Blazor application. The following example demonstrates how to specify a connection string provider to allow users to create new SQL data sources based on connection strings from the MySolution.Blazor.Server\appsettings.json file:

csharp
using DevExpress.ExpressApp.Dashboards.Blazor;
// ...
public class Startup {
    // ...
    public void ConfigureServices(IServiceCollection services){
        //...
        services.AddXafDashboards((dashboardConfigurator, services) => {
            var configuration = services.GetRequiredService<IConfiguration>();
            dashboardConfigurator.SetConnectionStringsProvider(new DashboardConnectionStringsProvider(configuration));
        });
        // ...
    }
    // ...
}

See Also

StartupExtensions Class

StartupExtensions Members

DevExpress.ExpressApp.Dashboards.Blazor Namespace