RouteCollectionExtensions.MapRoute Method (RouteCollection, String, String, Object, Object)
Maps the specified URL route and sets default route values and constraints.
Namespace: System.Web.Mvc
Assembly: System.Web.Mvc (in System.Web.Mvc.dll)
Syntax
'Declaration
<ExtensionAttribute> _
Public Shared Function MapRoute ( _
routes As RouteCollection, _
name As String, _
url As String, _
defaults As Object, _
constraints As Object _
) As Route
public static Route MapRoute(
this RouteCollection routes,
string name,
string url,
Object defaults,
Object constraints
)
[ExtensionAttribute]
public:
static Route^ MapRoute(
RouteCollection^ routes,
String^ name,
String^ url,
Object^ defaults,
Object^ constraints
)
Parameters
- routes
Type: System.Web.Routing.RouteCollection
A collection of routes for the application.
- name
Type: System.String
The name of the route to map.
- url
Type: System.String
The URL pattern for the route.
- defaults
Type: System.Object
An object that contains default route values.
- constraints
Type: System.Object
A set of expressions that specify values for the url parameter.
Return Value
Type: System.Web.Routing.Route
A reference to the mapped route.
Usage Note
In Visual Basic and C#, you can call this method as an instance method on any object of type RouteCollection. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).
Exceptions
| Exception | Condition |
|---|---|
| ArgumentNullException | The routes or url parameter is null reference (Nothing in Visual Basic). |