AreaRegistrationContext Class

Article
02/21/2011

Encapsulates the information that is required in order to register an area within an ASP.NET MVC application.

Inheritance Hierarchy

System.Object
System.Web.Mvc.AreaRegistrationContext

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

Syntax

'Declaration
Public Class AreaRegistrationContext

public class AreaRegistrationContext

public ref class AreaRegistrationContext

The AreaRegistrationContext type exposes the following members.

Constructors

	Name	Description
	AreaRegistrationContext(String, RouteCollection)	Initializes a new instance of the AreaRegistrationContext class using the specified area name and routes collection.
	AreaRegistrationContext(String, RouteCollection, Object)	Initializes a new instance of the AreaRegistrationContext class using the specified area name, routes collection, and user-defined data.

Top

Properties

	Name	Description
	AreaName	Gets the name of the area to register.
	Namespaces	Gets the namespaces for the application.
	Routes	Gets a collection of defined routes for the application.
	State	Gets an object that contains user-defined information to pass to the area.

Top

Methods

	Name	Description
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MapRoute(String, String)	Maps the specified URL route and associates it with the area that is specified by the AreaName property.
	MapRoute(String, String, Object)	Maps the specified URL route and associates it with the area that is specified by the AreaName property, using the specified route default values.
	MapRoute(String, String, String[])	Maps the specified URL route and associates it with the area that is specified by the AreaName property, using the specified namespaces.
	MapRoute(String, String, Object, Object)	Maps the specified URL route and associates it with the area that is specified by the AreaName property, using the specified route default values and constraint.
	MapRoute(String, String, Object, String[])	Maps the specified URL route and associates it with the area that is specified by the AreaName property, using the specified route default values and namespaces.
	MapRoute(String, String, Object, Object, String[])	Maps the specified URL route and associates it with the area that is specified by the AreaName property, using the specified route default values, constraints, and namespaces.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

The primary use of this context object is to call one of the area-enabled MapRoute method overloads, which mirror MapRoute methods.

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.

Share via