Export (0) Print
Expand All

RoleManagerModule::GetRoles Event

A global application event that is raised when the RoleManagerModule is ready to create a RolePrincipal that represents the current user.

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

public:
 event RoleManagerEventHandler^ GetRoles {
	void add (RoleManagerEventHandler^ value);
	void remove (RoleManagerEventHandler^ value);
}

The GetRoles event is raised before the RoleManagerModule creates a RolePrincipal object and assigns it to the User property of the Current HttpContext. You can use this event to audit when role information is applied or to replace the creation of a RolePrincipal by the RoleManagerModule with your own code.

You can cancel the application of role information by the RoleManagerModule by setting the RolesPopulated property of the RoleManagerEventArgs to true in the GetRoles event.

If you set RolesPopulated to true in your GetRoles event handler, then the User property of the current HttpContext is not set to a RolePrincipal object by the RoleManagerModule.

The following example shows the GetRoles event included in the Global.asax file for an ASP.NET application. The GetRoles event adds a trace notification for an application where trace is enabled in the Web.config file.

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

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0
Show:
© 2015 Microsoft