PrincipalCollection Class

Definition

Namespace:

System.DirectoryServices.AccountManagement

Assembly:

System.DirectoryServices.AccountManagement.dll

Package:

System.DirectoryServices.AccountManagement v9.0.0

Source:

PrincipalCollection.cs

A mutable collection of objects derived from the Principal class. This class is designed to be used for multi-valued properties that contain Principal objects. Manipulating the contents of this collection changes the contents of the corresponding store property, which is made permanent when Save() is called on the corresponding principal object.

public ref class PrincipalCollection : System::Collections::Generic::ICollection<System::DirectoryServices::AccountManagement::Principal ^>, System::Collections::Generic::IEnumerable<System::DirectoryServices::AccountManagement::Principal ^>, System::Collections::ICollection

public class PrincipalCollection : System.Collections.Generic.ICollection<System.DirectoryServices.AccountManagement.Principal>, System.Collections.Generic.IEnumerable<System.DirectoryServices.AccountManagement.Principal>, System.Collections.ICollection

type PrincipalCollection = class
    interface ICollection<Principal>
    interface seq<Principal>
    interface IEnumerable
    interface ICollection

Public Class PrincipalCollection
Implements ICollection, ICollection(Of Principal), IEnumerable(Of Principal)

Inheritance

Object

PrincipalCollection

Implements

ICollection<Principal> IEnumerable<Principal> IEnumerable<T> ICollection IEnumerable

Properties

Count	Returns the count of Principal objects in this collection.
IsReadOnly	Returns false. This is not a read-only collection.
IsSynchronized	Returns false. It is up to the application to serialize access to this collection.
SyncRoot	Returns a synchronization object that can be used to synchronize access to this collection.

Methods

Add(ComputerPrincipal)	Adds the specified ComputerPrincipal object to the end of the collection.
Add(GroupPrincipal)	Adds the specified GroupPrincipal object to the end of the collection.
Add(Principal)	Adds the specified Principal object to the end of the collection.
Add(PrincipalContext, IdentityType, String)	Searches for a Principal object that matches the parameters, and adds it to the end of the collection.
Add(UserPrincipal)	Adds the specified UserPrincipal object to the end of the collection.
Clear()	Removes all Principal objects from the collection.
Contains(ComputerPrincipal)	Returns a value indicating whether the collection contains the specified ComputerPrincipal object.
Contains(GroupPrincipal)	Returns a value indicating whether the collection contains the specified GroupPrincipal object.
Contains(Principal)	Returns a value indicating whether the collection contains the specified Principal object.
Contains(PrincipalContext, IdentityType, String)	Returns a value indicating whether the Principal object matching the identityType/identityValue pair is in the collection.
Contains(UserPrincipal)	Returns a value indicating whether the collection contains the specified UserPrincipal object.
CopyTo(Principal[], Int32)	Copies the Principal objects from this PrincipalCollection into the specified array, starting at the specified position index in array.
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetEnumerator()	Returns an enumerator to iterate through the principals in the PrincipalCollection.
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(ComputerPrincipal)	Removes the specified ComputerPrincipal object from the collection, and returns true if the ComputerPrincipal was a member of this PrincipalCollection, and false otherwise (in which case the method performs no operation).
Remove(GroupPrincipal)	Removes the specified GroupPrincipal object from the collection, and returns true if the GroupPrincipal was a member of this PrincipalCollection, and false otherwise (in which case the method performs no operation).
Remove(Principal)	Removes the specified Principal object from the collection, and returns true if the Principal was a member of this PrincipalCollection, and false otherwise (in which case the method performs no operation).
Remove(PrincipalContext, IdentityType, String)	Finds the UserPrincipal object specified by the given PrincipalContext and identityType/identityValue pair from the collection, and returns true if the identified Principal was a member of this PrincipalCollection, and false otherwise (in which case the method performs no operation).
Remove(UserPrincipal)	Removes the specified UserPrincipal object from the collection, and returns true if the UserPrincipal was a member of this PrincipalCollection, and false otherwise (in which case the method performs no operation).
ToString()	Returns a string that represents the current object. (Inherited from Object)

Explicit Interface Implementations

ICollection.CopyTo(Array, Int32)	Copies the Principal objects from this PrincipalCollection into the specified array, starting at the specified position index in array.
ICollection.Count	Returns the count of Principal objects in this collection.
ICollection.IsSynchronized	Always returns false. It is up to the application to synchronize access to this collection.
ICollection.SyncRoot	Returns a synchronization object that can be used to synchronize access to this collection. Returns the PrincipalCollection object itself.
IEnumerable.GetEnumerator()	Returns an enumerator to iterate through the principals in the PrincipalCollection.

Extension Methods

ToFrozenDictionary<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>, IEqualityComparer<TKey>)	Creates a FrozenDictionary<TKey,TValue> from an IEnumerable<T> according to specified key selector function.
ToFrozenDictionary<TSource,TKey,TElement>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TElement>, IEqualityComparer<TKey>)	Creates a FrozenDictionary<TKey,TValue> from an IEnumerable<T> according to specified key selector and element selector functions.
ToFrozenSet<T>(IEnumerable<T>, IEqualityComparer<T>)	Creates a FrozenSet<T> with the specified values.
ToImmutableArray<TSource>(IEnumerable<TSource>)	Creates an immutable array from the specified collection.
ToImmutableDictionary<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>, IEqualityComparer<TKey>)	Constructs an immutable dictionary based on some transformation of a sequence.
ToImmutableDictionary<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>)	Constructs an immutable dictionary from an existing collection of elements, applying a transformation function to the source keys.
ToImmutableDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>, IEqualityComparer<TKey>, IEqualityComparer<TValue>)	Enumerates and transforms a sequence, and produces an immutable dictionary of its contents by using the specified key and value comparers.
ToImmutableDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>, IEqualityComparer<TKey>)	Enumerates and transforms a sequence, and produces an immutable dictionary of its contents by using the specified key comparer.
ToImmutableDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>)	Enumerates and transforms a sequence, and produces an immutable dictionary of its contents.
ToImmutableHashSet<TSource>(IEnumerable<TSource>, IEqualityComparer<TSource>)	Enumerates a sequence, produces an immutable hash set of its contents, and uses the specified equality comparer for the set type.
ToImmutableHashSet<TSource>(IEnumerable<TSource>)	Enumerates a sequence and produces an immutable hash set of its contents.
ToImmutableList<TSource>(IEnumerable<TSource>)	Enumerates a sequence and produces an immutable list of its contents.
ToImmutableSortedDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>, IComparer<TKey>, IEqualityComparer<TValue>)	Enumerates and transforms a sequence, and produces an immutable sorted dictionary of its contents by using the specified key and value comparers.
ToImmutableSortedDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>, IComparer<TKey>)	Enumerates and transforms a sequence, and produces an immutable sorted dictionary of its contents by using the specified key comparer.
ToImmutableSortedDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>)	Enumerates and transforms a sequence, and produces an immutable sorted dictionary of its contents.
ToImmutableSortedSet<TSource>(IEnumerable<TSource>, IComparer<TSource>)	Enumerates a sequence, produces an immutable sorted set of its contents, and uses the specified comparer.
ToImmutableSortedSet<TSource>(IEnumerable<TSource>)	Enumerates a sequence and produces an immutable sorted set of its contents.