RouteBuilderExtension.MapDashboardRoute(IEndpointRouteBuilder, String, String, String) Method

Maps the specified URL route and sets a prefix, controller and area names.

Namespace: DevExpress.DashboardAspNetCore

Assembly: DevExpress.Dashboard.v23.2.AspNetCore.dll

NuGet Package: DevExpress.AspNetCore.Dashboard

Declaration

C#

public static void MapDashboardRoute(
    this IEndpointRouteBuilder endpointRouteBuilder,
    string routePrefix,
    string controllerName,
    string areaName
)

VB.NET

<ExtensionAttribute>
Public Shared Sub MapDashboardRoute(
    endpointRouteBuilder As IEndpointRouteBuilder,
    routePrefix As String,
    controllerName As String,
    areaName As String
)

Parameters

Name	Type	Description
endpointRouteBuilder	IEndpointRouteBuilder	The IEndpointRouteBuilder to add the route to.
routePrefix	String	A String value that specifies a route prefix.
controllerName	String	A String value that specifies the controller name.
areaName	String	A String value that specifies the name of the area to register.

Remarks

When Web Dashboard is used within areas, you may encounter error messages like The dashboard "" is not found. This message indicates that the ASP.NET Routing is adjusted incorrectly and Web Dashboard requests are sent to the incorrect URL. In this case, use MapDashboardRoute overload with the areaName parameter.

A route prefix is used to handle requests from the client-side DashboardControl. Use the following properties in the client applications to specify the endpoint:

• Client app with DashboardControl: DashboardControlOptions.endpoint
• ASP.NET Core Razor app: DashboardBackendOptionsBuilder.Uri
• ASP.NET MVC Razor app: DashboardBackendOptions.Uri