Export (0) Print
Expand All

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

Provides a way to define routes for Web Forms applications.

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

public Route MapPageRoute(
	string routeName,
	string routeUrl,
	string physicalFile,
	bool checkPhysicalUrlAccess,
	RouteValueDictionary defaults,
	RouteValueDictionary constraints,
	RouteValueDictionary dataTokens
)

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.
defaults
Type: System.Web.Routing.RouteValueDictionary
Default values for the route parameters.
constraints
Type: System.Web.Routing.RouteValueDictionary
Constraints that a URL request must meet in order to be processed as this route.
dataTokens
Type: System.Web.Routing.RouteValueDictionary
Values that are associated with the route that are not used to determine whether a route matches a URL pattern.

Return Value

Type: System.Web.Routing.Route
The route that is added to the route collection.

ExceptionCondition
ArgumentNullException

The routeUrl parameter is null.

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("ExpenseDetailRoute",
    "ExpenseReportDetail/{locale}/{year}/{*queryvalues}", "~/expenses.aspx",
    false,
    new RouteValueDictionary 
        { { "locale", "US" }, { "year", DateTime.Now.Year.ToString() } },
    new RouteValueDictionary 
        { { "locale", "[a-z]{2}" }, { "year", @"\d{4}" } },
    new RouteValueDictionary 
        { { "account", "1234" }, { "subaccount", "5678" } });


.NET Framework

Supported in: 4

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Community Additions

ADD
Show:
© 2014 Microsoft