HttpRouteCollection Class

Article
10/28/2015

A collection of IHttpRoute instances.

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

Inheritance Hierarchy

System.Object
System.Web.Http.HttpRouteCollection

Syntax

[DefaultMemberAttribute("Item")]
public class HttpRouteCollection : ICollection<IHttpRoute>, IEnumerable<IHttpRoute>, 
    IEnumerable, IDisposable

[DefaultMemberAttribute("Item")]
public ref class HttpRouteCollection : ICollection<IHttpRoute^>, 
    IEnumerable<IHttpRoute^>, IEnumerable, IDisposable

[<DefaultMemberAttribute("Item")>]
type HttpRouteCollection = 
    class
        interface ICollection<IHttpRoute>
        interface IEnumerable<IHttpRoute>
        interface IEnumerable
        interface IDisposable
    end

<DefaultMemberAttribute("Item")>
Public Class HttpRouteCollection
    Implements ICollection(Of IHttpRoute), IEnumerable(Of IHttpRoute),
    IEnumerable, IDisposable

Constructors

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

Properties

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

Methods

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

Explicit Interface Implementations

	Name	Description
	ICollection<IHttpRoute>.Add(IHttpRoute)
	ICollection<IHttpRoute>.Remove(IHttpRoute)
	IEnumerable.GetEnumerator()	Returns an enumerator that iterates through the collection.

Extension Methods

	Name	Description
	IgnoreRoute(String, String)	Overloaded. Ignores the specified route.(Defined by HttpRouteCollectionExtensions.)
	IgnoreRoute(String, String, Object)	Overloaded. Ignores the specified route.(Defined by HttpRouteCollectionExtensions.)
	MapHttpBatchRoute(String, String, HttpBatchHandler)	Maps the specified route for handling HTTP batch requests. (Defined by HttpRouteCollectionExtensions.)
	MapHttpRoute(String, String)	Overloaded. Maps the specified route template.(Defined by HttpRouteCollectionExtensions.)
	MapHttpRoute(String, String, Object)	Overloaded. Maps the specified route template and sets default route values.(Defined by HttpRouteCollectionExtensions.)
	MapHttpRoute(String, String, Object, Object)	Overloaded. Maps the specified route template and sets default route values and constraints.(Defined by HttpRouteCollectionExtensions.)
	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.)

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.