SPUserCollection members
Represents a collection of SPUser objects.
The SPUserCollection type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
Count | Gets the number of users in the collection. (Overrides SPBaseCollection.Count.) |
|
Item[Int32] | Gets the user object at the specified index in the collection. In C#, this property is an indexer for the SPUserCollection class. |
|
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. |
|
RetrieveAllRoles | Gets or sets a Boolean value that specifies whether to preload roles for users to increase performance. (Inherited from SPMemberCollection.) |
|
SchemaXmlEx | Gets a list schema that specifies fields used to define the collection. |
|
ViewSchemaXmlEx | Gets a schema that describes the default view used to return user information for the collection. |
|
Web | Gets the Web site to which the collection belongs. (Inherited from SPMemberCollection.) |
|
Xml | Gets an XML representation of the collection. |
|
XmlEx | Gets the collection in XMLDATA format. |
Top
Methods
| Name | Description | |
|---|---|---|
.gif "Public method") |
Add | Adds the specified user to the collection. |
|
AddCollection | Adds a collection of users to the existing collection based on an array that specifies user information. |
|
Equals | (Inherited from Object.) |
.gif "Protected method") |
Finalize | (Inherited from Object.) |
|
GetByEmail | Returns the user with the specified e-mail address. |
|
GetByID | Returns the user with the specified member ID. |
|
GetCollection | Returns a collection of users with the specified user names. |
|
GetEnumerator | Gets an enumerator to iterate through the collection. (Inherited from SPBaseCollection.) |
|
GetHashCode | (Inherited from Object.) |
|
GetType | (Inherited from Object.) |
|
GetTypedEnumerator<T> | Returns a type-safe enumerator to iterate through the collection. (Inherited from SPBaseCollection.) |
|
MemberwiseClone | (Inherited from Object.) |
|
Remove(Int32) | Removes the user at the specified index in the collection. |
|
Remove(String) | Removes the user with the specified user name from the collection. |
|
RemoveByID | Removes the user with the specified member ID from the collection. |
|
RemoveCollection | Removes the collection of users represented by a string array that contains their user names. |
|
ToString | (Inherited from Object.) |
Top
Fields
| Name | Description | |
|---|---|---|
.gif "Protected field") |
m_arrRolesData | Store the role definition data as a two-dimensional array. (Inherited from SPMemberCollection.) |
|
m_dwCountRoles | Store the number of role definitions. (Inherited from SPMemberCollection.) |
|
m_role | Store the role definition to which the collection belongs. (Inherited from SPMemberCollection.) |
|
m_web | Store the Web site to which the collection belongs. (Inherited from SPMemberCollection.) |
Top
Explicit interface implementations
| Name | Description | |
|---|---|---|
.gif "Explicit interface implemetation") .gif "Private method") |
ICollection.CopyTo | Copies the elements of the collection to an array, starting at the specified array index. (Inherited from SPBaseCollection.) |
.gif "Private property") |
ICollection.IsSynchronized | Gets a Boolean value that indicates whether access to the collection is synchronized or thread-safe. (Inherited from SPBaseCollection.) |
|
ICollection.SyncRoot | Gets an object that is used to synchronize access to the collection. (Inherited from SPBaseCollection.) |
Top