HttpRouteCollection Class

  • Article

A collection of IHttpRoute instances.

Inheritance Hierarchy

System.Object
  System.Web.Http.HttpRouteCollection

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

Syntax

'Declaration
Public Class HttpRouteCollection _
    Implements ICollection(Of IHttpRoute), IEnumerable(Of IHttpRoute),  _
    IEnumerable, IDisposable
'Usage
Dim instance As HttpRouteCollection

public class HttpRouteCollection : ICollection<IHttpRoute>, 
    IEnumerable<IHttpRoute>, IEnumerable, IDisposable

public ref class HttpRouteCollection : ICollection<IHttpRoute^>, 
    IEnumerable<IHttpRoute^>, IEnumerable, IDisposable

type HttpRouteCollection =  
    class
        interface ICollection<IHttpRoute>
        interface IEnumerable<IHttpRoute>
        interface IEnumerable
        interface IDisposable
    end

public class HttpRouteCollection implements ICollection<IHttpRoute>, IEnumerable<IHttpRoute>, IEnumerable, IDisposable

The HttpRouteCollection type exposes the following members.

Constructors

  Name Description
Public method HttpRouteCollection() Initializes a new instance of the HttpRouteCollection class.
Public method HttpRouteCollection(String) Initializes a new instance of the HttpRouteCollection class.

Top

Properties

  Name Description
Public property Count Gets the number of items in the collection.
Public property IsReadOnly Gets a value indicating whether the collection is read-only.
Public property Item[Int32] Gets or sets the element at the specified index.
Public property Item[String] Gets or sets the element with the specified route name.
Public property VirtualPathRoot Gets the virtual path root.

Top

Methods

  Name Description
Public method Add Adds an IHttpRoute instance to the collection.
Public method Clear Removes all items from the collection.
Public method Contains Determines whether the collection contains a specific IHttpRoute.
Public method ContainsKey Determines whether the collection contains an element with the specified key.
Public method CopyTo(KeyValuePair<String, IHttpRoute>[], Int32) Copies the IHttpRoute instances of the collection to an array, starting at a particular array index.
Public method CopyTo(IHttpRoute[], Int32) Copies the route names and IHttpRoute instances of the collection to an array, starting at a particular array index.
Public method CreateRoute(String, Object, Object) Creates an IHttpRoute instance.
Public method CreateRoute(String, IDictionary<String, Object>, IDictionary<String, Object>, IDictionary<String, Object>) Creates an IHttpRoute instance.
Public method CreateRoute(String, IDictionary<String, Object>, IDictionary<String, Object>, IDictionary<String, Object>, HttpMessageHandler) Creates an IHttpRoute instance.
Public method Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Protected method Dispose(Boolean) Releases the unmanaged resources that are used by the object and, optionally, releases the managed resources.
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetEnumerator Returns an enumerator that iterates through the collection.
Public method GetHashCode (Inherited from Object.)
Public method GetRouteData Gets the route data for a specified HTTP request.
Public method GetType (Inherited from Object.)
Public method GetVirtualPath Gets a virtual path.
Public method Insert Inserts an IHttpRoute instance into the collection.
Protected method MemberwiseClone (Inherited from Object.)
Protected method OnGetEnumerator Called internally to get the enumerator for the collection.
Public method Remove Removes an IHttpRoute instance from the collection.
Public method ToString (Inherited from Object.)
Public method TryGetValue Gets the IHttpRoute with the specified route name.

Top

Extension Methods

  Name Description
Public Extension Method MapHttpRoute(String, String) Overloaded. Maps the specified route template. (Defined by HttpRouteCollectionExtensions.)
Public Extension Method MapHttpRoute(String, String, Object) Overloaded. Maps the specified route template and sets default route values. (Defined by HttpRouteCollectionExtensions.)
Public Extension Method MapHttpRoute(String, String, Object, Object) Overloaded. Maps the specified route template and sets default route values and constraints. (Defined by HttpRouteCollectionExtensions.)
Public Extension Method MapHttpRoute(String, String, Object, Object, HttpMessageHandler) Overloaded. Maps the specified route template and sets default route values, constraints, and end-point message handler. (Defined by HttpRouteCollectionExtensions.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method ICollection<IHttpRoute>.Add Adds an item to the collection.
Explicit interface implemetationPrivate method IEnumerable.GetEnumerator Returns an enumerator that iterates through the collection.
Explicit interface implemetationPrivate method ICollection<IHttpRoute>.Remove Removes the first occurrence of a specific object from the collection.

Top

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

System.Web.Http Namespace