Provider Property

Roles.Provider Property


Gets the default role provider for the application.

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

public static RoleProvider Provider { get; }

Property Value

Type: System.Web.Security.RoleProvider

The default role provider for the application, which is exposed as a class that inherits the RoleProvider abstract class.

Exception Condition

Role management is not enabled.

The Provider property enables you to directly reference the default role provider for an application. This is commonly used to access custom members of the role provider that are not part of the RoleProvider abstract class.

For example, the WindowsTokenRoleProvider class includes an overload of the IsUserInRole method that enables you to determine whether a user is in a common Windows role by using a WindowsBuiltInRole enumeration value. A reference to the WindowsTokenRoleProvider class for an application can be obtained by using the Provider property and can be cast as a WindowsTokenRoleProvider in order to refer to the IsUserInRole overload.

If multiple role providers are configured for an application, you can access different role providers using the Providers collection.

The following code example casts the default role provider as a WindowsTokenRoleProvider and checks whether the currently logged-on user is in the Administrators role before allowing the user to view roles settings for the application. For an example of a Web.config file that enables role management, see WindowsTokenRoleProvider.

<%@ Page Language="C#" %>
<%@ Import Namespace="System.Web.Security" %>
<%@ Import Namespace="System.Security.Principal" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
<script runat="server">

string[] rolesArray;

public void Page_Load()
  Msg.Text = "";

  WindowsPrincipal p = (WindowsPrincipal)System.Threading.Thread.CurrentPrincipal;

  if (!p.IsInRole(WindowsBuiltInRole.Administrator))
    Msg.Text = "You are not authorized to view user roles.";

  // Bind roles to GridView.

    rolesArray = Roles.GetRolesForUser(User.Identity.Name);
  catch (HttpException e)
    Msg.Text = "There is no current logged on user. Role membership cannot be verified.";

  UserRolesGrid.DataSource = rolesArray;

  UserRolesGrid.Columns[0].HeaderText = "Roles for " + User.Identity.Name;

<html xmlns="" >
<title>Sample: View User Roles</title>

<form runat="server" id="PageForm">

  <h3>View User Roles</h3>

  <asp:Label id="Msg" ForeColor="maroon" runat="server" /><br />

  <table border="0" cellspacing="4">
      <td valign="top"><asp:GridView runat="server" CellPadding="4" id="UserRolesGrid" 
                                     AutoGenerateColumns="false" Gridlines="None" 
                                     CellSpacing="0" >
                         <HeaderStyle BackColor="navy" ForeColor="white" />
                           <asp:TemplateField HeaderText="Roles" >
                               <%# Container.DataItem.ToString() %>



.NET Framework
Available since 2.0
Return to top
© 2015 Microsoft