SPGroupCollection class

Representa uma coleção de objetos SPGroup .

Inheritance hierarchy

System.Object
  Microsoft.SharePoint.Administration.SPAutoSerializingObject
    Microsoft.SharePoint.SPBaseCollection
      Microsoft.SharePoint.SPMemberCollection
        Microsoft.SharePoint.SPGroupCollection

Namespace:  Microsoft.SharePoint
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)

Syntax

'Declaração
Public Class SPGroupCollection _
    Inherits SPMemberCollection
'Uso
Dim instance As SPGroupCollection

public class SPGroupCollection : SPMemberCollection

Comentários

Use a propriedade Groups da classe SPUser ou a classe SPWeb para retornar a coleção de grupos do usuário ou site da Web. Caso contrário, use a propriedade OwnedGroups da classe SPUser para retornar os grupos pertencentes a um usuário ou a propriedade SiteGroups da classe SPWeb para retornar todos os grupos no conjunto de sites.

Para criar um grupo no conjunto de sites, use o método Add .

Use um indexador para retornar um único grupo da coleção de grupos. Por exemplo, supondo que a coleção é atribuído a uma variável chamada collGroups , use collGroups[index] em C# ou deindexde collGroups() em Microsoft Visual Basic, onde index é o número de índice do grupo na coleção ou o nome do grupo.

Examples

O exemplo de código a seguir itera através de todos os grupos em um conjunto de sites e exclui todos os grupos que pertencem ao usuário especificado.

Dim webSite As SPWeb = SPContext.Current.Site.RootWeb
Try
    Dim users As SPUserCollection = webSite.Users
    Dim user As SPUser = webSite.Users("User_Name")
 
    Dim webGroups As SPGroupCollection = webSite.SiteGroups
    Dim userGroups As SPGroupCollection = user.OwnedGroups
 
    Dim userGroup As SPGroup
    For Each userGroup In  userGroups
        webGroups.RemoveByID(userGroup.ID)
    Next userGroup
Finally
    webSite.Dispose()
End Try

using (SPWeb oWebsiteRoot = SPContext.Current.Site.RootWeb)
{
    SPUserCollection collUsers = oWebsiteRoot.Users;
    SPUser oUser = oWebsiteRoot.Users["User_Name"];

    SPGroupCollection collGroupsWebsite = oWebsiteRoot.SiteGroups;
    SPGroupCollection collGroupsUser = oUser.OwnedGroups;

    foreach (SPGroup oUserGroup in collGroupsUser)
    {
        collGroupsWebsite.RemoveByID(oUserGroup.ID);
    }
}

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.

Ver também

Referência

SPGroupCollection members

Microsoft.SharePoint namespace