Export (0) Print
Expand All

RouteCollection.Add Method (String, RouteBase)

Adds a route to the end of the RouteCollection object and assigns the specified name to the route.

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

'Declaration
Public Sub Add ( _
	name As String, _
	item As RouteBase _
)

Parameters

name
Type: System.String
The value that identifies the route. The value can be Nothing or an empty string.
item
Type: System.Web.Routing.RouteBase
The route to add to the end of the collection.

ExceptionCondition
ArgumentNullException

item is Nothing.

ArgumentException

name is already used in the collection.

The Add method enables you to define a name for a route when you add it to the route collection. By defining a name for the route, you can specify a particular route to use when you use routing to construct a URL. Specifying a particular route is important when more than one route matches the values that you pass to the GetVirtualPath method. If you do not specify a named route, ASP.NET routing will use the first route in the collection that matches the values. For more information, see How to: Construct URLs from Routes.

A name can be used only one time in the RouteCollection object.

If you do not have to specify a name for the route, you can add the route by calling the Add method.

Use the GetReadLock method and the GetWriteLock method to make sure that you interact with the collection without conflicts from other processes.

The following example shows how to add a route to a RouteCollection object and assign a name to the route.


Sub Application_Start(ByVal sender As Object, ByVal e As EventArgs)
    RegisterRoutes(RouteTable.Routes)
End Sub


.NET Framework

Supported in: 4, 3.5 SP1

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:
© 2015 Microsoft