SelectingProviderEventArgs Class

Provides data for the SelectingProvider event.

System.Object
  System.EventArgs
    System.Web.ApplicationServices.SelectingProviderEventArgs

Namespace:  System.Web.ApplicationServices
Assembly:  System.Web.Extensions (in System.Web.Extensions.dll)

'Declaration
Public Class SelectingProviderEventArgs _
	Inherits EventArgs

The SelectingProviderEventArgs type exposes the following members.

  NameDescription
Public propertyProviderNameGets or sets the role provider to use for retrieving the user's roles.
Public propertyUserGets the authenticated user.
Top

  NameDescription
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

The SelectingProviderEventArgs class supplies values to the SelectingProvider event handler. You create a SelectingProvider event handler to select the role provider at run time.

The RoleService class raises the SelectingProvider event when either the IsCurrentUserInRole method or the GetRolesForCurrentUser method of the RoleService class is called.

You use the User property to retrieve information about the logged-in user. To retrieve role information through a non-default role provider, set the ProviderName property to the name of the role provider that you want the RoleService object to use.

The following example shows an event handler for the SelectingProvider event. The event handler uses the SelectingProviderEventArgs object to check the user name and to set the role provider to use. The event handler is bound to the SelectingProvider event in the Application_Start method of the Global.asax file.

Sub Application_Start(ByVal sender As Object, ByVal e As EventArgs)
    AddHandler System.Web.ApplicationServices.RoleService.SelectingProvider, _
        AddressOf Me.RoleService_SelectingProvider
End Sub

Sub RoleService_SelectingProvider _
(ByVal sender As Object, _
 ByVal e As System.Web.ApplicationServices.SelectingProviderEventArgs)

    If (e.User.Identity.Name.IndexOf("@example.com") > 0) Then
        e.ProviderName = "EmployeeRoleProvider"
    Else
        e.ProviderName = "CustomerRoleProvider"
    End If
End Sub

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5

Windows 8.1, Windows Server 2012 R2, 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.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft