RouteCollectionExtension.MapDashboardRoute(RouteCollection, String, String, String[], String) Method

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

Namespace: DevExpress.DashboardWeb.Mvc

Assembly: DevExpress.Dashboard.v20.2.Web.Mvc5.dll

NuGet Package: DevExpress.Web.Mvc5.Dashboard

Declaration

C#

public static void MapDashboardRoute(
    this RouteCollection routes,
    string routePrefix,
    string controllerName,
    string[] namespaces,
    string areaName
)

VB.NET

<ExtensionAttribute>
Public Shared Sub MapDashboardRoute(
    routes As RouteCollection,
    routePrefix As String,
    controllerName As String,
    namespaces As String(),
    areaName As String
)

Parameters

Name	Type	Description
routes	RouteCollection	A collection of the RouteCollection objects that are routes for the application.
routePrefix	String	A String value that specifies a route prefix.
controllerName	String	A String value that specifies the controller name.
namespaces	String[]	A set of namespaces for the application.
areaName	String	A String value that specifies the name of the area to register.

Remarks

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

• HTML JavaScript: DashboardControlOptions.endpoint
• ASP.NET Core: DashboardBackendOptionsBuilder.Uri
• ASP.NET MVC: DashboardBackendOptions.Uri

To learn how to adjust routing when a Web Dashboard is used in ASP.NET MVC Areas, see the T541859 KB article.