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)

System.Object
  System.Web.Mvc.AreaRegistration

[<AbstractClass>]
type AreaRegistration = class end

NameDescription
System_CAPS_protmethodAreaRegistration()

Initializes a new instance of the AreaRegistration class.

NameDescription
System_CAPS_pubpropertyAreaName

Gets the name of the area to register.

NameDescription
System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_protmethodFinalize()

(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethodSystem_CAPS_staticRegisterAllAreas()

Registers all areas in an ASP.NET MVC application.

System_CAPS_pubmethodSystem_CAPS_staticRegisterAllAreas(Object)

Registers all areas in an ASP.NET MVC application by using the specified user-defined information.

System_CAPS_pubmethodRegisterArea(AreaRegistrationContext)

Registers an area in an ASP.NET MVC application using the specified area's context information.

System_CAPS_pubmethodToString()

(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.

No code example is currently available or this language may not be supported.

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

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

Return to top
Show: