Share via


SPUserCollection Members

Include Protected Members
Include Inherited Members

Represents a collection of SPUser objects.

The SPUserCollection type exposes the following members.

Properties

  Name Description
Public property Count Gets the number of users in the collection. (Overrides SPBaseCollection.Count.)
Public property Item[Int32] Gets the user object at the specified index in the collection. In C#, this property is an indexer for the SPUserCollection class.
Public property Item[String] Gets the user object with the specified user name from the collection. In C#, this property is an indexer for the SPUserCollection class.
Public property RetrieveAllRoles Gets or sets a Boolean value that specifies whether to preload roles for users to increase performance. (Inherited from SPMemberCollection.)
Public property SchemaXmlEx Gets a list schema that specifies fields used to define the collection.
Public property UpgradedPersistedProperties (Inherited from SPAutoSerializingObject.)
Public property ViewSchemaXmlEx Gets a schema that describes the default view used to return user information for the collection.
Public property Web Gets the Web site to which the collection belongs. (Inherited from SPMemberCollection.)
Public property Xml Gets an XML representation of the collection.
Public property XmlEx Gets the collection in XMLDATA format.

Top

Methods

  Name Description
Public method Add Adds the specified user to the collection.
Public method AddCollection Adds a collection of users to the existing collection based on an array that specifies user information.
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetByEmail Returns the user with the specified e-mail address.
Public method GetByID Returns the user with the specified member ID.
Public method GetCollection Returns a collection of users with the specified user names.
Public method GetEnumerator Gets an enumerator to iterate through the collection. (Inherited from SPBaseCollection.)
Public method GetHashCode (Inherited from Object.)
Public method GetObjectData (Inherited from SPAutoSerializingObject.)
Public method GetType (Inherited from Object.)
Public method GetTypedEnumerator<T> Returns a type-safe enumerator to iterate through the collection. (Inherited from SPBaseCollection.)
Protected method MemberwiseClone (Inherited from Object.)
Protected method OnDeserialization (Inherited from SPAutoSerializingObject.)
Public method Remove(Int32) Removes the user at the specified index in the collection.
Public method Remove(String) Removes the user with the specified user name from the collection.
Public method RemoveByID Removes the user with the specified member ID from the collection.
Public method RemoveCollection Removes the collection of users represented by a string array that contains their user names.
Public method ToString (Inherited from Object.)
Protected method UpdateParent (Inherited from SPAutoSerializingObject.)

Top

Fields

  Name Description
Protected field m_arrRolesData Store the role definition data as a two-dimensional array. (Inherited from SPMemberCollection.)
Protected field m_dwCountRoles Store the number of role definitions. (Inherited from SPMemberCollection.)
Protected field m_role Store the role definition to which the collection belongs. (Inherited from SPMemberCollection.)
Protected field m_web Store the Web site to which the collection belongs. (Inherited from SPMemberCollection.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method ICollection.CopyTo Copies the elements of the collection to an array, starting at the specified array index. (Inherited from SPBaseCollection.)
Explicit interface implemetationPrivate property ICollection.IsSynchronized Gets a Boolean value that indicates whether access to the collection is synchronized or thread-safe. (Inherited from SPBaseCollection.)
Explicit interface implemetationPrivate property ICollection.SyncRoot Gets an object that is used to synchronize access to the collection. (Inherited from SPBaseCollection.)

Top

See Also

Reference

SPUserCollection Class

Microsoft.SharePoint Namespace