RoleManagerEventHandler Delegate

 

Defines the delegate for the GetRoles event of the RoleManagerModule class.

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

Public Delegate Sub RoleManagerEventHandler (
	sender As Object,
	e As RoleManagerEventArgs
)

Parameters

sender
Type: System.Object

The RoleManagerModule that raised the GetRoles event.

e
Type: System.Web.Security.RoleManagerEventArgs

A RoleManagerEventArgs object that contains the event data.

The RoleManagerEventHandler delegate is defined for the GetRoles event of the RoleManagerModule class. You can access the GetRoles event of the RoleManagerModule class in the Global.asax file for your ASP.NET application as shown in the example for this topic.

You can use the RoleManagerEventHandler to replace the creation of the RolePrincipal object by the RoleManagerModule with your own custom object. To do this, define a delegate using the RoleManagerEventHandler and assign it to the GetRoles event of 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 Sub RoleManager_OnGetRoles(sender As Object, args As RoleManagerEventArgs)
  args.Context.Trace.Write("Roles", "Applying Role Information")
End Sub

.NET Framework
Available since 2.0
Return to top
Show: