Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

RoleProviderCollection Class

A collection of objects that inherit the RoleProvider abstract class.

Namespace:  System.Web.Security
Assembly:  System.Web (in System.Web.dll)
public sealed class RoleProviderCollection : ProviderCollection

The RoleProviderCollection type exposes the following members.

  NameDescription
Public methodRoleProviderCollectionCreates a new, empty role-provider collection.
Top
  NameDescription
Public propertyCountGets the number of providers in the collection. (Inherited from ProviderCollection.)
Public propertyIsSynchronizedGets a value indicating whether access to the collection is synchronized (thread safe). (Inherited from ProviderCollection.)
Public propertyItemGets the role provider in the collection referenced by the specified provider name.
Public propertySyncRootGets the current object. (Inherited from ProviderCollection.)
Top
  NameDescription
Public methodAddAdds a role provider to the collection. (Overrides ProviderCollection.Add(ProviderBase).)
Public methodClearRemoves all items from the collection. (Inherited from ProviderCollection.)
Public methodCopyTo(ProviderBase[], Int32)Copies the contents of the collection to the given array starting at the specified index. (Inherited from ProviderCollection.)
Public methodCopyTo(RoleProvider[], Int32)Copies the role provider collection to a one-dimensional array.
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodGetEnumeratorReturns an object that implements the IEnumerator interface to iterate through the collection. (Inherited from ProviderCollection.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodRemoveRemoves a provider from the collection. (Inherited from ProviderCollection.)
Public methodSetReadOnlySets the collection to be read-only. (Inherited from ProviderCollection.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top
  NameDescription
Explicit interface implemetationPrivate methodICollection.CopyToCopies the elements of the ProviderCollection to an array, starting at a particular array index. (Inherited from ProviderCollection.)
Top

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.

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

<%@ 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>

.NET Framework

Supported in: 4.5.1, 4.5, 4, 3.5, 3.0, 2.0

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show:
© 2014 Microsoft. All rights reserved.