CreateRole Method

Roles.CreateRole Method (String)


Adds a new role to the data source.

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

public static void CreateRole(
	string roleName


Type: System.String

The name of the role to create.

Exception Condition

roleName is null.


roleName is an empty string.


roleName contains a comma.


Role management is not enabled.

The CreateRole method adds a role name to the data source. CreateRole calls the CreateRole method of the default role provider to add the specified role to the data source.


Role names cannot contain commas.

The following code example creates a new role in the data source. For an example of a Web.config file that enables role management, see Roles.

System_CAPS_security Security Note

This example contains a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see Script Exploits Overview.

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

string[] rolesArray;

public void Page_Load(object sender, EventArgs args)
  if (!IsPostBack)
    // Bind roles to GridView.

    rolesArray = Roles.GetAllRoles();
    RolesGrid.DataSource = rolesArray;

public void CreateRole_OnClick(object sender, EventArgs args)
  string createRole = RoleTextBox.Text;

    if (Roles.RoleExists(createRole))
      Msg.Text = "Role '" + Server.HtmlEncode(createRole) + "' already exists. Please specify a different role name.";


    Msg.Text = "Role '" + Server.HtmlEncode(createRole) + "' created.";

    // Re-bind roles to GridView.

    rolesArray = Roles.GetAllRoles();
    RolesGrid.DataSource = rolesArray;
  catch (Exception e)
    Msg.Text = "Role '" + Server.HtmlEncode(createRole) + "' <u>not</u> created.";


<html xmlns="" >
<title>Sample: Create Role</title>

<form runat="server" id="PageForm">
  <h3>Create a Role</h3>

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

  Role name: 

  <asp:TextBox id="RoleTextBox" runat="server" />

  <asp:Button Text="Create Role" id="CreateRoleButton"
              runat="server" OnClick="CreateRole_OnClick" />

  <br />

  <asp:GridView runat="server" CellPadding="2" id="RolesGrid" 
                Gridlines="Both" CellSpacing="2" AutoGenerateColumns="false" >
    <HeaderStyle BackColor="navy" ForeColor="white" />
      <asp:TemplateField HeaderText="Roles" >
          <%# Container.DataItem.ToString() %>


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