RolePrincipal.IsInRole Method (String)


The .NET API Reference documentation has a new home. Visit the .NET API Browser on to see the new experience.

Gets a value indicating whether the user represented by the RolePrincipal is in the specified role.

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

public override bool IsInRole(
	string role


Type: System.String

The role to search for.

Return Value

Type: System.Boolean

true if user represented by the RolePrincipal is in the specified role; otherwise, false.

Exception Condition

The Identity property is null.

IsInRole first checks the IsRoleListCached property to determine whether a cached list of role names for the current user is available. If the IsRoleListCached property is true, the cached list is checked for the specified role. If the IsInRole method finds the specified role in the cached list, it returns true.

If IsInRole does not find the specified role, it calls the GetRolesForUser method of the default Provider instance to determine whether the user name is associated with a role from the data source for the configured ApplicationName value.

The following code example checks to see whether the logged-on user is in the Administrators role before allowing the user to view user roles.

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

string[] rolesArray;
MembershipUserCollection users;

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

  if (!User.IsInRole("Administrators"))
    Msg.Text = "You are not authorized to view user roles.";
    UsersListBox.Visible = false;

  if (!IsPostBack)
    // Bind users to ListBox.

    users = Membership.GetAllUsers();
    UsersListBox.DataSource = users;

  // If a user is selected, show the roles for the selected user.

  if (UsersListBox.SelectedItem != null)
    // Bind roles to GridView.

    rolesArray = Roles.GetRolesForUser(UsersListBox.SelectedItem.Value);
    UserRolesGrid.DataSource = rolesArray;

    UserRolesGrid.Columns[0].HeaderText = "Roles for " + UsersListBox.SelectedItem.Value;

<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:ListBox id="UsersListBox" DataTextField="Username" 
                                    Rows="8" AutoPostBack="true" runat="server" /></td>
      <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