SPUser class
Represents a user in Microsoft SharePoint Foundation.
Inheritance hierarchy
System.Object
Microsoft.SharePoint.SPMember
Microsoft.SharePoint.SPPrincipal
Microsoft.SharePoint.SPUser
Namespace: Microsoft.SharePoint
Assembly: Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Syntax
'Declaration
Public NotInheritable Class SPUser _
Inherits SPPrincipal
'Usage
Dim instance As SPUser
public sealed class SPUser : SPPrincipal
Remarks
Use the AllUsers property of the SPWeb class to return all the users of a site. This includes users granted permissions directly, users granted permissions through a group who have then visited the site, and users who have been referenced in a person field, such as being assigned a task. Calling AllUsers[name] will throw an exception if the user is not there.
Use the SiteUsers property of the SPWeb class to return all the users in the site collection.
Use the GetAllAuthenticatedUsers method of the SPUtility class to return all authenticated users of a site.
Use the GetUniqueUsers method of the SPAlertCollection class to return a list of users for a collection of alerts.
Otherwise, use the Users property of the SPGroup or SPWeb class to return the users in a group or site.
Use an indexer to return a single user from the collection. For example, if the collection is assigned to a variable named collUsers, use collUsers[index] in C#, or collUsers(index) in Visual Basic, where index is either the index number of the user in the collection or the user name of the user.
Every user has a unique member ID (ID property), has the permissions associated with that membership, and can be represented by an SPMember object. The following example assigns a user to an SPMember object, given a specified SharePoint Web site:
Dim oWebsite As SPWeb = SPContext.Current.Web
Dim oMember As SPMember = oWebsite.AllUsers("Domain\\User_Alias")
SPWeb oWebsite = SPContext.Current.Web;
SPMember oMember = oWebsite.AllUsers["Domain\\User_Alias"];
For general information about users and security, see Security, Users, and Groups in Windows SharePoint Services.
Examples
The following code example modifies the e-mail address, display name, and notes for a specified user object.
Dim siteCollection As SPSite = SPControl.GetContextSite(Context)
Dim site As SPWeb = siteCollection.AllWebs("Site_Name")
Dim user As SPUser = site.AllUsers("User_Name")
user.Email = "E-mail_Address"
user.Name = "Display_Name"
user.Notes = "User_Notes"
user.Update()
SPSite oSiteCollection = SPContext.Current.Site;
using (SPWeb oWebsite = oSiteCollection.AllWebs["Website_Name"])
{
SPUser oUser = oWebsite.AllUsers["User_Name"];
oUser.Email = " E-mail_Address";
oUser.Name = " Display_Name";
oUser.Notes = " User_Notes";
oUser.Update();
}
Note
Certain objects implement the IDisposable interface, and you must avoid retaining these objects in memory after they are no longer needed. For information about good coding practices, see Disposing Objects.
Thread safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.