SPWeb.SiteUsers Property

Gets the collection of all users that belong to the site collection.

Namespace:  Microsoft.SharePoint
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Available in Sandboxed Solutions: Yes
Available in SharePoint Online

Syntax

'Declaration
Public ReadOnly Property SiteUsers As SPUserCollection
    Get
'Usage
Dim instance As SPWeb
Dim value As SPUserCollection

value = instance.SiteUsers

public SPUserCollection SiteUsers { get; }

Property Value

Type: Microsoft.SharePoint.SPUserCollection
An SPUserCollection object that represents the users.

Examples

The following code example uses the SiteUsers property to return the collection of users for the current site collection and the user display names

This example requires using directives (Imports in Microsoft Visual Basic) for the Microsoft.SharePoint and Microsoft.SharePoint.Utilities namespaces.

Using webSite As SPWeb = SPContext.Current.Site.OpenWeb("Website_URL")
    Dim users As SPUserCollection = webSite.SiteUsers

    For Each user As SPUser In users
        Response.Write((SPEncode.HtmlEncode(user.Name) + "<BR>"))
    Next
End Using

using (SPWeb oWebsite = SPContext.Current.Site.OpenWeb("Website_URL"))
{
    SPUserCollection collUsers = oWebsite.SiteUsers;
    foreach (SPUser oUser in collUsers)
    {
        Response.Write(SPEncode.HtmlEncode(oUser.Name) + "<BR>");
    }
}

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.

See Also

Reference

SPWeb Class

SPWeb Members

Microsoft.SharePoint Namespace