RoleManagerEventHandler Delegate (System.Web.Security)

Switch View :

Classic

Lightweight

ScriptFree

Site Feedback

.NET Framework Class Library

RoleManagerEventHandler Delegate

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

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

Syntax

Visual Basic

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

public delegate void RoleManagerEventHandler(
	Object sender,
	RoleManagerEventArgs e
)

Visual C++

public delegate void RoleManagerEventHandler(
	Object^ sender, 
	RoleManagerEventArgs^ e
)

type RoleManagerEventHandler = 
    delegate of 
        sender:Object * 
        e:RoleManagerEventArgs -> unit

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.

Remarks

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.

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.

Visual Basic


Public Sub RoleManager_OnGetRoles(sender As Object, args As RoleManagerEventArgs)
  args.Context.Trace.Write("Roles", "Applying Role Information")
End Sub


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

Version Information

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

Platforms

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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

Reference

System.Web.Security Namespace

GetRoles

Other Resources

Managing Authorization Using Roles