SPWeb.SiteGroups Property

Gets a collection that contains all the groups in the site collection.

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

Syntax

'Declaration
<ClientCallableAttribute> _
Public ReadOnly Property SiteGroups As SPGroupCollection
    Get
'Usage
Dim instance As SPWeb
Dim value As SPGroupCollection

value = instance.SiteGroups

[ClientCallableAttribute]
public SPGroupCollection SiteGroups { get; }

Property Value

Type: Microsoft.SharePoint.SPGroupCollection
A collection of SPGroup objects that represent the groups in the site collection.

Examples

The following code example uses the SiteGroups property to return the collection of groups in the current site collection, and also displays the name of each group.

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("Site_Name")
    Dim myGroups As SPGroupCollection = webSite.SiteGroups

    For Each group As SPGroup In myGroups
        Response.Write((SPEncode.HtmlEncode(group.Name) + "<BR>"))
    Next group
End Using

using (SPWeb oWebsite = SPContext.Current.Site.OpenWeb("Website_URL"))
{
    SPGroupCollection collGroups = oWebsite.SiteGroups;
    foreach (SPGroup oGroup in collGroups)
    {
        Response.Write(SPEncode.HtmlEncode(oGroup.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

Groups