RoleManagerModule.GetRoles RoleManagerModule.GetRoles RoleManagerModule.GetRoles RoleManagerModule.GetRoles Event

Definition

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

public:
 event System::Web::Security::RoleManagerEventHandler ^ GetRoles;
public event System.Web.Security.RoleManagerEventHandler GetRoles;
member this.GetRoles : System.Web.Security.RoleManagerEventHandler 
Public Custom Event GetRoles As RoleManagerEventHandler 

Examples

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");
}
Public Sub RoleManager_OnGetRoles(sender As Object, args As RoleManagerEventArgs)
  args.Context.Trace.Write("Roles", "Applying Role Information")
End Sub

Remarks

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.

Applies to

See also