RoleProviderCollection Class (System.Web.Security)

Switch View :
Classic
Lightweight
ScriptFree
.NET Framework Class Library
RoleProviderCollection Class

A collection of objects that inherit the RoleProvider abstract class.

Inheritance Hierarchy
System.Object
  System.Configuration.Provider.ProviderCollection
    System.Web.Security.RoleProviderCollection

Namespace:  System.Web.Security
Assembly:  System.Web (in System.Web.dll)
Syntax
Visual Basic
Public NotInheritable Class RoleProviderCollection _
	Inherits ProviderCollection
C#
public sealed class RoleProviderCollection : ProviderCollection
Visual C++
public ref class RoleProviderCollection sealed : public ProviderCollection
F#
[<Sealed>]
type RoleProviderCollection =  
    class
        inherit ProviderCollection
    end

The RoleProviderCollection type exposes the following members.

Constructors
  Name Description
Public method RoleProviderCollection Creates a new, empty role-provider collection.
Top
Properties
  Name Description
Public property Count Gets the number of providers in the collection. (Inherited from ProviderCollection.)
Public property IsSynchronized Gets a value indicating whether access to the collection is synchronized (thread safe). (Inherited from ProviderCollection.)
Public property Item Gets the role provider in the collection referenced by the specified provider name.
Public property SyncRoot Gets the current object. (Inherited from ProviderCollection.)
Top
Methods
  Name Description
Public method Add Adds a role provider to the collection. (Overrides ProviderCollection.Add(ProviderBase).)
Public method Clear Removes all items from the collection. (Inherited from ProviderCollection.)
Public method CopyTo(ProviderBase[], Int32) Copies the contents of the collection to the given array starting at the specified index. (Inherited from ProviderCollection.)
Public method CopyTo(RoleProvider[], Int32) Copies the role provider collection to a one-dimensional array.
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetEnumerator Returns an object that implements the IEnumerator interface to iterate through the collection. (Inherited from ProviderCollection.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method Remove Removes a provider from the collection. (Inherited from ProviderCollection.)
Public method SetReadOnly Sets the collection to be read-only. (Inherited from ProviderCollection.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Top
Explicit Interface Implementations
  Name Description
Explicit interface implemetation Private method ICollection.CopyTo Copies the elements of the ProviderCollection to an array, starting at a particular array index. (Inherited from ProviderCollection.)
Top
Remarks

The role providers for an application are exposed as a read-only RoleProviderCollection by the Providers property of the Roles class. You can access a specific role provider in the collection by name and cast it as the specific provider type, such as SqlRoleProvider. This enables you to manage role information from multiple data stores in a single application as well as access custom members of a role provider that are not part of the RoleProvider abstract class.

Examples

The following code example lists the providers enabled for an application and their respective types.

Visual Basic

<%@ Page Language="VB" %>
<%@ Import Namespace="System.Web.Security" %>
<%@ Import Namespace="System.Configuration.Provider" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >
<head>
<title>List Enabled Providers</title>
</head>
<body>

<%
For Each p As RoleProvider In Roles.Providers
  Response.Write(p.Name & ", " & p.GetType().ToString() & "<br />")
Next
%>

</body>
</html>
C#

<%@ Page Language="C#" %>
<%@ Import Namespace="System.Web.Security" %>
<%@ Import Namespace="System.Configuration.Provider" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >
<head>
<title>List Enabled Providers</title>
</head>
<body>

<%
foreach (RoleProvider p in Roles.Providers)
  Response.Write(p.Name + ", " + p.GetType() + "<br />");
%>

</body>
</html>
Version Information

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0
Platforms

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
See Also

Reference

System.Web.Security Namespace

Other Resources

Understanding Role Management