This topic has not yet been rated - Rate this topic

RoleManagerEventHandler Delegate

.NET Framework 4.5

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

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

public delegate void RoleManagerEventHandler(
	Object sender,
	RoleManagerEventArgs e
)

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.

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

Version Information

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0

Platforms

Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)