AreaRegistration Class
Provides a way to register one or more areas in an ASP.NET MVC application.
Namespace: System.Web.Mvc
Assembly: System.Web.Mvc (in System.Web.Mvc.dll)
The AreaRegistration type exposes the following members.
| Name | Description | |
|---|---|---|
|
Equals | (Inherited from Object.) |
|
Finalize | (Inherited from Object.) |
|
|
GetHashCode | (Inherited from Object.) |
|
|
GetType | (Inherited from Object.) |
|
|
MemberwiseClone | (Inherited from Object.) |
|
RegisterAllAreas() | Registers all areas in an ASP.NET MVC application. |
|
|
RegisterAllAreas(Object) | Registers all areas in an ASP.NET MVC application by using the specified user-defined information. |
|
|
RegisterArea | Registers an area in an ASP.NET MVC application using the specified area's context information. |
|
|
ToString | (Inherited from Object.) |
When you add an area to an ASP.NET MVC application, Visual Studio creates a file named AreaRegistration. The file contains a class that derives from AreaRegistration. This class defines the AreaName property and the RegisterArea method, which registers the route information for the new area.
The following example shows the AreaRegistration class created for a new area named Blog.
public class BlogAreaRegistration : AreaRegistration { public override string AreaName { get { return "Blog"; } } public override void RegisterArea(AreaRegistrationContext context) { context.MapRoute( "Blog_default", "Blog/{controller}/{action}/{id}", new { action = "Index", id = "" } ); } }
The Global.asax file contains the RegisterRoutes method that is called when an ASP.NET MVC application starts. The RegisterRoutes method of any application that implements areas must contain a call to the RegisterAllAreas method.
The following example shows a RegisterRoutes method that contains a call to RegisterAllAreas.
public static void RegisterRoutes(RouteCollection routes) { routes.IgnoreRoute("{resource}.axd/{*pathInfo}"); AreaRegistration.RegisterAllAreas(); routes.MapRoute( "Default", // Route name "{controller}/{action}/{id}", // URL with parameters new { controller = "Home", action = "Index", id = "" } // Parameter defaults ); }
[Visual Basic]
Shared Sub RegisterRoutes(ByVal routes As RouteCollection)
routes.IgnoreRoute("{resource}.axd/{*pathInfo}")
AreaRegistration.RegisterAllAreas()
routes.MapRoute( _
"Default", _
"{controller}/{action}/{id}", _
New With {.controller = "Home", .action = "Index", .id = ""} _
)
End Sub
