SelectingProviderEventArgs SelectingProviderEventArgs SelectingProviderEventArgs SelectingProviderEventArgs Class

Definition

Provides data for the SelectingProvider event.

public ref class SelectingProviderEventArgs : EventArgs
public class SelectingProviderEventArgs : EventArgs
type SelectingProviderEventArgs = class
    inherit EventArgs
Public Class SelectingProviderEventArgs
Inherits EventArgs
Inheritance
SelectingProviderEventArgsSelectingProviderEventArgsSelectingProviderEventArgsSelectingProviderEventArgs

Examples

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.

void Application_Start(object sender, EventArgs e) 
{
    System.Web.ApplicationServices.RoleService.SelectingProvider += 
        new EventHandler<System.Web.ApplicationServices.SelectingProviderEventArgs>(RoleService_SelectingProvider);
}

void RoleService_SelectingProvider
    (object sender, System.Web.ApplicationServices.SelectingProviderEventArgs e)
{
    if (e.User.Identity.Name.IndexOf("@example.com") > 0)
    {
        e.ProviderName = "EmployeeRoleProvider";
    }
    else
    {
        e.ProviderName = "CustomerRoleProvider";
    }
}
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

Remarks

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.

Properties

ProviderName ProviderName ProviderName ProviderName

Gets or sets the role provider to use for retrieving the user's roles.

User User User User

Gets the authenticated user.

Methods

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetType() GetType() GetType() GetType()

Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
ToString() ToString() ToString() ToString()

Returns a string that represents the current object.

(Inherited from Object)

Applies to

See also