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

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.

public void RoleManager_OnGetRoles(object sender, RoleManagerEventArgs args)
{
  args.Context.Trace.Write("Roles", "Applying Role Information");
}

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2015 Microsoft