RouteCollection.MapPageRoute Method (String, String, String, Boolean)

.NET Framework (current version)
 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Provides a way to define routes for Web Forms applications.

Namespace:   System.Web.Routing
Assembly:  System.Web (in System.Web.dll)

Public Function MapPageRoute (
	routeName As String,
	routeUrl As String,
	physicalFile As String,
	checkPhysicalUrlAccess As Boolean
) As Route

Parameters

routeName
Type: System.String

The name of the route.

routeUrl
Type: System.String

The URL pattern for the route.

physicalFile
Type: System.String

The physical URL for the route.

checkPhysicalUrlAccess
Type: System.Boolean

A value that indicates whether ASP.NET should validate that the user has authority to access the physical URL (the route URL is always checked). This parameter sets the PageRouteHandler.CheckPhysicalUrlAccess property.

Return Value

Type: System.Web.Routing.Route

The route that is added to the route collection.

This method is provided for coding convenience. It is equivalent to calling the Add method and passing a Route object that is created by using the PageRouteHandler class.

The following example shows how to define a route by using this method. This example is part of a larger example that is available in the MapPageRoute method overview.

routes.MapPageRoute("SalesDetailRoute",
    "SalesReportDetail/{locale}/{year}/{*queryvalues}", "~/sales.aspx",
    False)

.NET Framework
Available since 4.0
Return to top
Show: