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
/** @event */
public void add_GetRoles (RoleManagerEventHandler value)

/** @event */
public void remove_GetRoles (RoleManagerEventHandler value)

In JScript, you can handle the events defined by a class, but you cannot define your own.
Not applicable.

The GetRoles event is raised before the RoleManagerModule creates a RolePrincipal object and assigns it to the User property of the CurrentHttpContext. 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 98, Windows Server 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0

Community Additions

ADD
Show:
© 2014 Microsoft