Export (0) Print
Expand All

RoleGroupCollection Class

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.

System.Object
  System.Collections.CollectionBase
    System.Web.UI.WebControls.RoleGroupCollection

Namespace:  System.Web.UI.WebControls
Assembly:  System.Web (in System.Web.dll)

public sealed class RoleGroupCollection : CollectionBase

The RoleGroupCollection type exposes the following members.

  NameDescription
Public methodRoleGroupCollectionInitializes a new instance of the RoleGroupCollection class.
Top

  NameDescription
Public propertyCapacityGets or sets the number of elements that the CollectionBase can contain. (Inherited from CollectionBase.)
Public propertyCountGets the number of elements contained in the CollectionBase instance. This property cannot be overridden. (Inherited from CollectionBase.)
Public propertyItemGets the role group at the specified index.
Top

  NameDescription
Public methodAddAdds a role group to the end of the collection.
Public methodClearRemoves all objects from the CollectionBase instance. This method cannot be overridden. (Inherited from CollectionBase.)
Public methodContainsIndicates whether the collection contains the specified role group.
Public methodCopyToCopies 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.
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodGetEnumeratorReturns an enumerator that iterates through the CollectionBase instance. (Inherited from CollectionBase.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetMatchingRoleGroupReturns the first role group that contains the specified user account.
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodIndexOfSearches the collection and returns the zero-based index of the first occurrence of the specified RoleGroup.
Public methodInsertAdds a RoleGroup to the collection at the specified index.
Public methodRemoveDeletes the first occurrence of the specified role group from the collection.
Public methodRemoveAtRemoves the element at the specified index of the CollectionBase instance. This method is not overridable. (Inherited from CollectionBase.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Explicit interface implemetationPrivate methodICollection.CopyToCopies the entire CollectionBase to a compatible one-dimensional Array, starting at the specified index of the target array. (Inherited from CollectionBase.)
Explicit interface implemetationPrivate propertyICollection.IsSynchronizedGets a value indicating whether access to the CollectionBase is synchronized (thread safe). (Inherited from CollectionBase.)
Explicit interface implemetationPrivate propertyICollection.SyncRootGets an object that can be used to synchronize access to the CollectionBase. (Inherited from CollectionBase.)
Explicit interface implemetationPrivate methodIList.AddAdds an object to the end of the CollectionBase. (Inherited from CollectionBase.)
Explicit interface implemetationPrivate methodIList.ContainsDetermines whether the CollectionBase contains a specific element. (Inherited from CollectionBase.)
Explicit interface implemetationPrivate methodIList.IndexOfSearches for the specified Object and returns the zero-based index of the first occurrence within the entire CollectionBase. (Inherited from CollectionBase.)
Explicit interface implemetationPrivate methodIList.InsertInserts an element into the CollectionBase at the specified index. (Inherited from CollectionBase.)
Explicit interface implemetationPrivate propertyIList.IsFixedSizeGets a value indicating whether the CollectionBase has a fixed size. (Inherited from CollectionBase.)
Explicit interface implemetationPrivate propertyIList.IsReadOnlyGets a value indicating whether the CollectionBase is read-only. (Inherited from CollectionBase.)
Explicit interface implemetationPrivate propertyIList.ItemGets or sets the element at the specified index. (Inherited from CollectionBase.)
Explicit interface implemetationPrivate methodIList.RemoveRemoves the first occurrence of a specific object from the CollectionBase. (Inherited from CollectionBase.)
Top

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 noteCaution

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.

.NET Framework

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

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