Home Library Learn Downloads Support Community
Sign in | United States - English | |
0 out of 1 rated this helpful - Rate this topic

RouteCollection Class

.NET Framework 4

Provides a collection of routes for ASP.NET routing.

System.Object
  System.Collections.ObjectModel.Collection<RouteBase>
    System.Web.Routing.RouteCollection

Namespace:  System.Web.Routing
Assembly:  System.Web (in System.Web.dll)
C#
C++
F#
VB
Copy 
public class RouteCollection : Collection<RouteBase>

The RouteCollection type exposes the following members.

  Name Description
Public method RouteCollection() Initializes a new instance of the RouteCollection class.
Public method RouteCollection(VirtualPathProvider) Infrastructure. Initializes a new instance of the RouteCollection class by using the specified virtual path provider.
Top
  Name Description
Public property Count Gets the number of elements actually contained in the Collection<T>. (Inherited from Collection<T>.)
Public property Item[Int32] Gets or sets the element at the specified index. (Inherited from Collection<T>.)
Public property Item[String] Gets the route in the collection that has the specified name.
Protected property Items Gets a IList<T> wrapper around the Collection<T>. (Inherited from Collection<T>.)
Public property RouteExistingFiles Gets or sets a value that indicates whether ASP.NET routing should handle URLs that match an existing file.
Top
  Name Description
Public method Add(T) Adds an object to the end of the Collection<T>. (Inherited from Collection<T>.)
Public method Add(String, RouteBase) Adds a route to the end of the RouteCollection object and assigns the specified name to the route.
Public method Clear Removes all elements from the Collection<T>. (Inherited from Collection<T>.)
Protected method ClearItems Removes all the elements from the RouteCollection object. (Overrides Collection<T>.ClearItems().)
Public method Contains Determines whether an element is in the Collection<T>. (Inherited from Collection<T>.)
Public method CopyTo Copies the entire Collection<T> to a compatible one-dimensional Array, starting at the specified index of the target array. (Inherited from Collection<T>.)
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetEnumerator Returns an enumerator that iterates through the Collection<T>. (Inherited from Collection<T>.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetReadLock Provides an object for managing thread safety when you retrieve an object from the collection.
Public method GetRouteData Returns information about the route in the collection that matches the specified values.
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method GetVirtualPath(RequestContext, RouteValueDictionary) Returns information about the URL path that is associated with the route, given the specified context and parameter values.
Public method GetVirtualPath(RequestContext, String, RouteValueDictionary) Returns information about the URL path that is associated with the named route, given the specified context, route name, and parameter values.
Public method GetWriteLock Provides an object for managing thread safety when you add or remove elements in the collection.
Public method Ignore(String) Defines a URL pattern that should not be checked for matches against routes.
Public method Ignore(String, Object) Defines a URL pattern that should not be checked for matches against routes if a request URL meets the specified constraints.
Public method IndexOf Searches for the specified object and returns the zero-based index of the first occurrence within the entire Collection<T>. (Inherited from Collection<T>.)
Public method Insert Inserts an element into the Collection<T> at the specified index. (Inherited from Collection<T>.)
Protected method InsertItem Inserts the specified route into the RouteCollection object at the specified index. (Overrides Collection<T>.InsertItem(Int32, T).)
Public method MapPageRoute(String, String, String) Provides a way to define routes for Web Forms applications.
Public method MapPageRoute(String, String, String, Boolean) Provides a way to define routes for Web Forms applications.
Public method MapPageRoute(String, String, String, Boolean, RouteValueDictionary) Provides a way to define routes for Web Forms applications.
Public method MapPageRoute(String, String, String, Boolean, RouteValueDictionary, RouteValueDictionary) Provides a way to define routes for Web Forms applications.
Public method MapPageRoute(String, String, String, Boolean, RouteValueDictionary, RouteValueDictionary, RouteValueDictionary) Provides a way to define routes for Web Forms applications.
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method Remove Removes the first occurrence of a specific object from the Collection<T>. (Inherited from Collection<T>.)
Public method RemoveAt Removes the element at the specified index of the Collection<T>. (Inherited from Collection<T>.)
Protected method RemoveItem Removes the route from the RouteCollection object at the specified index. (Overrides Collection<T>.RemoveItem(Int32).)
Protected method SetItem Replaces the route at the specified index. (Overrides Collection<T>.SetItem(Int32, T).)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Top
  Name Description
Explicit interface implemetation Private method ICollection.CopyTo Copies the elements of the ICollection to an Array, starting at a particular Array index. (Inherited from Collection<T>.)
Explicit interface implemetation Private property ICollection<T>.IsReadOnly Gets a value indicating whether the ICollection<T> is read-only. (Inherited from Collection<T>.)
Explicit interface implemetation Private property ICollection.IsSynchronized Gets a value indicating whether access to the ICollection is synchronized (thread safe). (Inherited from Collection<T>.)
Explicit interface implemetation Private property ICollection.SyncRoot Gets an object that can be used to synchronize access to the ICollection. (Inherited from Collection<T>.)
Explicit interface implemetation Private method IEnumerable.GetEnumerator Returns an enumerator that iterates through a collection. (Inherited from Collection<T>.)
Explicit interface implemetation Private method IList.Add Adds an item to the IList. (Inherited from Collection<T>.)
Explicit interface implemetation Private method IList.Contains Determines whether the IList contains a specific value. (Inherited from Collection<T>.)
Explicit interface implemetation Private method IList.IndexOf Determines the index of a specific item in the IList. (Inherited from Collection<T>.)
Explicit interface implemetation Private method IList.Insert Inserts an item into the IList at the specified index. (Inherited from Collection<T>.)
Explicit interface implemetation Private property IList.IsFixedSize Gets a value indicating whether the IList has a fixed size. (Inherited from Collection<T>.)
Explicit interface implemetation Private property IList.IsReadOnly Gets a value indicating whether the IList is read-only. (Inherited from Collection<T>.)
Explicit interface implemetation Private property IList.Item Gets or sets the element at the specified index. (Inherited from Collection<T>.)
Explicit interface implemetation Private method IList.Remove Removes the first occurrence of a specific object from the IList. (Inherited from Collection<T>.)
Top

The RouteCollection class provides methods that enable you to manage a collection of objects that derive from the RouteBase class.

Typically, you will use the static Routes property of the RouteTable class to retrieve a RouteCollection object. The Routes property stores all the routes for an ASP.NET application. ASP.NET routing iterates through the routes in the Routes property to find the route that matches a URL.

To construct a URL, you call the GetVirtualPath method and pass in a collection of values. The GetVirtualPath method finds the first route with parameters that match the values that you passed in, and returns a VirtualPathData object that contains information about the matching route. You retrieve the URL through the VirtualPath property of the VirtualPathData object.

You can add a route either with a name or without a name. Including a name enables you to distinguish between similar routes when URLs are constructed. If you do not specify a name, ASP.NET routing uses the first matching route in the collection to construct a URL.

When you add an unnamed route to the RouteCollection object, you cannot add a route that already is in the collection. When you add a named route, you cannot use a name that already identifies a route in the collection.

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

For information about how to add routes to a RouteCollection object, see ASP.NET Routing.

.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.
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ
Get your FREE RouteCollection today!

Code:

UrlHelper u = new UrlHelper(requestContext);
var myRouteCollection = u.RouteCollection;


And your RequestContext can be found in Controller.Request.RequestContext, i.e. this.Request.RequestContext from within the controller.

History