RoleProviderCollection Class

Reference

Definition

Namespace:: System.Web.Security

Assembly:: System.Web.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

A collection of objects that inherit the RoleProvider abstract class.

public ref class RoleProviderCollection sealed : System::Configuration::Provider::ProviderCollection

public sealed class RoleProviderCollection : System.Configuration.Provider.ProviderCollection

type RoleProviderCollection = class
    inherit ProviderCollection

Public NotInheritable Class RoleProviderCollection
Inherits ProviderCollection

Inheritance: Object

ProviderCollection
RoleProviderCollection

Examples

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>

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

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.

Constructors

RoleProviderCollection()

Creates a new, empty role-provider collection.

Properties

Count	Gets the number of providers in the collection. (Inherited from ProviderCollection)
IsSynchronized	Gets a value indicating whether access to the collection is synchronized (thread safe). (Inherited from ProviderCollection)
Item[String]	Gets the role provider in the collection referenced by the specified provider name.
SyncRoot	Gets the current object. (Inherited from ProviderCollection)

Methods

Add(ProviderBase)	Adds a role provider to the collection.
Clear()	Removes all items from the collection. (Inherited from ProviderCollection)
CopyTo(ProviderBase[], Int32)	Copies the contents of the collection to the given array starting at the specified index. (Inherited from ProviderCollection)
CopyTo(RoleProvider[], Int32)	Copies the role provider collection to a one-dimensional array.
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetEnumerator()	Returns an object that implements the IEnumerator interface to iterate through the collection. (Inherited from ProviderCollection)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
Remove(String)	Removes a provider from the collection. (Inherited from ProviderCollection)
SetReadOnly()	Sets the collection to be read-only. (Inherited from ProviderCollection)
ToString()	Returns a string that represents the current object. (Inherited from Object)

Explicit Interface Implementations

ICollection.CopyTo(Array, Int32)

Copies the elements of the ProviderCollection to an array, starting at a particular array index.

(Inherited from ProviderCollection)

Extension Methods

Cast<TResult>(IEnumerable)	Casts the elements of an IEnumerable to the specified type.
OfType<TResult>(IEnumerable)	Filters the elements of an IEnumerable based on a specified type.
AsParallel(IEnumerable)	Enables parallelization of a query.
AsQueryable(IEnumerable)	Converts an IEnumerable to an IQueryable.

Applies to

Share via