RouteCollectionExtension.MapDashboardRoute(RouteCollection, String) Method

OBSOLETE

Use the MapDashboardRoute overload with the controllerName parameter instead. Create the DevExpress.DashboardWeb.Mvc.DashboardController descendant and pass its name as the controllerName parameter's value. For more information, see the following BC article: https://go.devexpress.com/Dashboard_BC1018632.aspx.

Maps the specified URL route and sets a prefix.

Namespace: DevExpress.DashboardWeb.Mvc

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

NuGet Package: DevExpress.Web.Mvc5.Dashboard

Declaration

C#

[Obsolete("Use the MapDashboardRoute overload with the controllerName parameter instead. Create the DevExpress.DashboardWeb.Mvc.DashboardController descendant and pass its name as the controllerName parameter's value. For more information, see the following BC article: https://go.devexpress.com/Dashboard_BC1018632.aspx.", true)]
public static void MapDashboardRoute(
    this RouteCollection routes,
    string routePrefix
)

VB.NET

<Obsolete("Use the MapDashboardRoute overload with the controllerName parameter instead. Create the DevExpress.DashboardWeb.Mvc.DashboardController descendant and pass its name as the controllerName parameter's value. For more information, see the following BC article: https://go.devexpress.com/Dashboard_BC1018632.aspx.", True)>
<ExtensionAttribute>
Public Shared Sub MapDashboardRoute(
    routes As RouteCollection,
    routePrefix 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.

Remarks

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