RouteCollection Class

Definition

Provides a collection of routes for ASP.NET routing.

public ref class RouteCollection : System::Collections::ObjectModel::Collection<System::Web::Routing::RouteBase ^>
public class RouteCollection : System.Collections.ObjectModel.Collection<System.Web.Routing.RouteBase>
type RouteCollection = class
    inherit Collection<RouteBase>
Public Class RouteCollection
Inherits Collection(Of RouteBase)
Inheritance
RouteCollection

Remarks

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 staticRoutes 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 more information about how to add a route to a route collection, see ASP.NET Routing.

Constructors

RouteCollection()

Initializes a new instance of the RouteCollection class.

RouteCollection(VirtualPathProvider)

Initializes a new instance of the RouteCollection class by using the specified virtual path provider.

Properties

AppendTrailingSlash

Gets or sets a value that indicates whether trailing slashes are added when virtual paths are normalized.

Count

Gets the number of elements actually contained in the Collection<T>.

(Inherited from Collection<T>)
Item[Int32]

Gets or sets the element at the specified index.

(Inherited from Collection<T>)
Item[String]

Gets the route in the collection that has the specified name.

Items

Gets a IList<T> wrapper around the Collection<T>.

(Inherited from Collection<T>)
LowercaseUrls

Gets or sets a value that indicates whether URLs are converted to lower case when virtual paths are normalized.

RouteExistingFiles

Gets or sets a value that indicates whether ASP.NET routing should handle URLs that match an existing file.

Methods

Add(String, RouteBase)

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

Add(T)

Adds an object to the end of the Collection<T>.

(Inherited from Collection<T>)
Clear()

Removes all elements from the Collection<T>.

(Inherited from Collection<T>)
ClearItems()

Removes all the elements from the RouteCollection object.

Contains(T)

Determines whether an element is in the Collection<T>.

(Inherited from Collection<T>)
CopyTo(T[], Int32)

Copies the entire Collection<T> to a compatible one-dimensional Array, starting at the specified index of the target array.

(Inherited from Collection<T>)
Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetEnumerator()

Returns an enumerator that iterates through the Collection<T>.

(Inherited from Collection<T>)
GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetReadLock()

Provides an object for managing thread safety when you retrieve an object from the collection.

GetRouteData(HttpContextBase)

Returns information about the route in the collection that matches the specified values.

GetType()

Gets the Type of the current instance.

(Inherited from Object)
GetVirtualPath(RequestContext, RouteValueDictionary)

Returns information about the URL path that is associated with the route, given the specified context and parameter values.

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.

GetWriteLock()

Provides an object for managing thread safety when you add or remove elements in the collection.

Ignore(String)

Defines a URL pattern that should not be checked for matches against routes.

Ignore(String, Object)

Defines a URL pattern that should not be checked for matches against routes if a request URL meets the specified constraints.

IndexOf(T)

Searches for the specified object and returns the zero-based index of the first occurrence within the entire Collection<T>.

(Inherited from Collection<T>)
Insert(Int32, T)

Inserts an element into the Collection<T> at the specified index.

(Inherited from Collection<T>)
InsertItem(Int32, RouteBase)

Inserts the specified route into the RouteCollection object at the specified index.

InsertItem(Int32, T)

Inserts an element into the Collection<T> at the specified index.

(Inherited from Collection<T>)
MapPageRoute(String, String, String)

Provides a way to define routes for Web Forms applications.

MapPageRoute(String, String, String, Boolean)

Provides a way to define routes for Web Forms applications.

MapPageRoute(String, String, String, Boolean, RouteValueDictionary)

Provides a way to define routes for Web Forms applications.

MapPageRoute(String, String, String, Boolean, RouteValueDictionary, RouteValueDictionary)

Provides a way to define routes for Web Forms applications.

MapPageRoute(String, String, String, Boolean, RouteValueDictionary, RouteValueDictionary, RouteValueDictionary)

Provides a way to define routes for Web Forms applications.

MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
Remove(T)

Removes the first occurrence of a specific object from the Collection<T>.

(Inherited from Collection<T>)
RemoveAt(Int32)

Removes the element at the specified index of the Collection<T>.

(Inherited from Collection<T>)
RemoveItem(Int32)

Removes the route from the RouteCollection object at the specified index.

SetItem(Int32, RouteBase)

Replaces the route at the specified index.

SetItem(Int32, T)

Replaces the element at the specified index.

(Inherited from Collection<T>)
ToString()

Returns a string that represents the current object.

(Inherited from Object)

Explicit Interface Implementations

ICollection.CopyTo(Array, Int32)

Copies the elements of the ICollection to an Array, starting at a particular Array index.

(Inherited from Collection<T>)
ICollection.IsSynchronized

Gets a value indicating whether access to the ICollection is synchronized (thread safe).

(Inherited from Collection<T>)
ICollection.SyncRoot

Gets an object that can be used to synchronize access to the ICollection.

(Inherited from Collection<T>)
ICollection<T>.IsReadOnly

Gets a value indicating whether the ICollection<T> is read-only.

(Inherited from Collection<T>)
IEnumerable.GetEnumerator()

Returns an enumerator that iterates through a collection.

(Inherited from Collection<T>)
IList.Add(Object)

Adds an item to the IList.

(Inherited from Collection<T>)
IList.Contains(Object)

Determines whether the IList contains a specific value.

(Inherited from Collection<T>)
IList.IndexOf(Object)

Determines the index of a specific item in the IList.

(Inherited from Collection<T>)
IList.Insert(Int32, Object)

Inserts an item into the IList at the specified index.

(Inherited from Collection<T>)
IList.IsFixedSize

Gets a value indicating whether the IList has a fixed size.

(Inherited from Collection<T>)
IList.IsReadOnly

Gets a value indicating whether the IList is read-only.

(Inherited from Collection<T>)
IList.Item[Int32]

Gets or sets the element at the specified index.

(Inherited from Collection<T>)
IList.Remove(Object)

Removes the first occurrence of a specific object from the IList.

(Inherited from Collection<T>)

Extension Methods

CopyToDataTable<T>(IEnumerable<T>)

Returns a DataTable that contains copies of the DataRow objects, given an input IEnumerable<T> object where the generic parameter T is DataRow.

CopyToDataTable<T>(IEnumerable<T>, DataTable, LoadOption)

Copies DataRow objects to the specified DataTable, given an input IEnumerable<T> object where the generic parameter T is DataRow.

CopyToDataTable<T>(IEnumerable<T>, DataTable, LoadOption, FillErrorEventHandler)

Copies DataRow objects to the specified DataTable, given an input IEnumerable<T> object where the generic parameter T is DataRow.

Cast<TResult>(IEnumerable)

Casts the elements of an IEnumerable to the specified type.

OfType<TResult>(IEnumerable)

Filters the elements of an IEnumerable based on a specified type.

AsParallel(IEnumerable)

Enables parallelization of a query.

AsQueryable(IEnumerable)

Converts an IEnumerable to an IQueryable.

Ancestors<T>(IEnumerable<T>)

Returns a collection of elements that contains the ancestors of every node in the source collection.

Ancestors<T>(IEnumerable<T>, XName)

Returns a filtered collection of elements that contains the ancestors of every node in the source collection. Only elements that have a matching XName are included in the collection.

DescendantNodes<T>(IEnumerable<T>)

Returns a collection of the descendant nodes of every document and element in the source collection.

Descendants<T>(IEnumerable<T>)

Returns a collection of elements that contains the descendant elements of every element and document in the source collection.

Descendants<T>(IEnumerable<T>, XName)

Returns a filtered collection of elements that contains the descendant elements of every element and document in the source collection. Only elements that have a matching XName are included in the collection.

Elements<T>(IEnumerable<T>)

Returns a collection of the child elements of every element and document in the source collection.

Elements<T>(IEnumerable<T>, XName)

Returns a filtered collection of the child elements of every element and document in the source collection. Only elements that have a matching XName are included in the collection.

InDocumentOrder<T>(IEnumerable<T>)

Returns a collection of nodes that contains all nodes in the source collection, sorted in document order.

Nodes<T>(IEnumerable<T>)

Returns a collection of the child nodes of every document and element in the source collection.

Remove<T>(IEnumerable<T>)

Removes every node in the source collection from its parent node.

Applies to

See also