RoleGroupCollection Class
.NET Framework 4
Contains a sequential list of role groups that the LoginView control uses to determine which control template to display to users based on their role. This class cannot be inherited.
Namespace:
System.Web.UI.WebControls
Assembly: System.Web (in System.Web.dll)
The RoleGroupCollection type exposes the following members.
| Name | Description | |
|---|---|---|
|
RoleGroupCollection | Initializes a new instance of the RoleGroupCollection class. |
| Name | Description | |
|---|---|---|
|
Capacity | Gets or sets the number of elements that the CollectionBase can contain. (Inherited from CollectionBase.) |
|
|
Count | Gets the number of elements contained in the CollectionBase instance. This property cannot be overridden. (Inherited from CollectionBase.) |
|
InnerList | Gets an ArrayList containing the list of elements in the CollectionBase instance. (Inherited from CollectionBase.) |
|
|
Item | Gets the role group at the specified index. |
|
|
List | Gets an IList containing the list of elements in the CollectionBase instance. (Inherited from CollectionBase.) |
| Name | Description | |
|---|---|---|
|
|
Add | Adds a role group to the end of the collection. |
|
|
Clear | Removes all objects from the CollectionBase instance. This method cannot be overridden. (Inherited from CollectionBase.) |
|
|
Contains | Indicates whether the collection contains the specified role group. |
|
|
CopyTo | Copies all the items from the RoleGroupCollection collection to a compatible one-dimensional array of RoleGroup objects, starting at the specified index in the target array. |
|
|
Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
|
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
|
|
GetEnumerator | Returns an enumerator that iterates through the CollectionBase instance. (Inherited from CollectionBase.) |
|
|
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
|
|
GetMatchingRoleGroup | Returns the first role group that contains the specified user account. |
|
|
GetType | Gets the Type of the current instance. (Inherited from Object.) |
|
|
IndexOf | Searches the collection and returns the zero-based index of the first occurrence of the specified RoleGroup. |
|
|
Insert | Adds a RoleGroup to the collection at the specified index. |
|
|
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
|
|
OnClear | Performs additional custom processes when clearing the contents of the CollectionBase instance. (Inherited from CollectionBase.) |
|
|
OnClearComplete | Performs additional custom processes after clearing the contents of the CollectionBase instance. (Inherited from CollectionBase.) |
|
|
OnInsert | Performs additional custom processes before inserting a new element into the CollectionBase instance. (Inherited from CollectionBase.) |
|
|
OnInsertComplete | Performs additional custom processes after inserting a new element into the CollectionBase instance. (Inherited from CollectionBase.) |
|
|
OnRemove | Performs additional custom processes when removing an element from the CollectionBase instance. (Inherited from CollectionBase.) |
|
|
OnRemoveComplete | Performs additional custom processes after removing an element from the CollectionBase instance. (Inherited from CollectionBase.) |
|
|
OnSet | Performs additional custom processes before setting a value in the CollectionBase instance. (Inherited from CollectionBase.) |
|
|
OnSetComplete | Performs additional custom processes after setting a value in the CollectionBase instance. (Inherited from CollectionBase.) |
|
|
OnValidate | Performs additional custom processes when validating a value. (Inherited from CollectionBase.) |
|
|
Remove | Deletes the first occurrence of the specified role group from the collection. |
|
|
RemoveAt | Removes the element at the specified index of the CollectionBase instance. This method is not overridable. (Inherited from CollectionBase.) |
|
|
ToString | Returns a string that represents the current object. (Inherited from Object.) |
| Name | Description | |
|---|---|---|
|
ICollection.CopyTo | Copies the entire CollectionBase to a compatible one-dimensional Array, starting at the specified index of the target array. (Inherited from CollectionBase.) |
|
ICollection.IsSynchronized | Gets a value indicating whether access to the CollectionBase is synchronized (thread safe). (Inherited from CollectionBase.) |
|
|
ICollection.SyncRoot | Gets an object that can be used to synchronize access to the CollectionBase. (Inherited from CollectionBase.) |
|
|
IList.Add | Adds an object to the end of the CollectionBase. (Inherited from CollectionBase.) |
|
|
IList.Contains | Determines whether the CollectionBase contains a specific element. (Inherited from CollectionBase.) |
|
|
IList.IndexOf | Searches for the specified Object and returns the zero-based index of the first occurrence within the entire CollectionBase. (Inherited from CollectionBase.) |
|
|
IList.Insert | Inserts an element into the CollectionBase at the specified index. (Inherited from CollectionBase.) |
|
|
IList.IsFixedSize | Gets a value indicating whether the CollectionBase has a fixed size. (Inherited from CollectionBase.) |
|
|
IList.IsReadOnly | Gets a value indicating whether the CollectionBase is read-only. (Inherited from CollectionBase.) |
|
|
IList.Item | Gets or sets the element at the specified index. (Inherited from CollectionBase.) |
|
|
IList.Remove | Removes the first occurrence of a specific object from the CollectionBase. (Inherited from CollectionBase.) |
The RoleGroupCollection class manages the list of role groups associated with a particular LoginView template. Each role group defines the content and controls to display to a particular group of users on your Web site. It is possible to assign several role groups to the same template.
To find the role group in the collection that a particular user belongs to, you can use the GetMatchingRoleGroup method to search the collection by user name.
Caution
|
|---|
|
The order of the roles in the RoleGroupCollection collection is important because matching is done sequentially based on the first role found. |
You must configure role management to use the RoleGroupCollection class to manage a list of role groups. For more information, see Understanding Role Management.
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.
