SPGroupCollection - Classe

Représente une collection d'objets SPGroup .

Hiérarchie d’héritage

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

Espace de noms :  Microsoft.SharePoint
Assembly :  Microsoft.SharePoint (dans Microsoft.SharePoint.dll)

Syntaxe

'Déclaration
Public Class SPGroupCollection _
    Inherits SPMemberCollection
'Utilisation
Dim instance As SPGroupCollection

public class SPGroupCollection : SPMemberCollection

Remarques

Utilisez la propriété Groups de la classe SPUser ou SPWeb pour renvoyer la collection des groupes de l'utilisateur ou d'un site Web. Sinon, utilisez la propriété OwnedGroups de la classe SPUser pour renvoyer les groupes appartenant à un utilisateur, ou la propriété SiteGroups de la classe SPWeb pour renvoyer tous les groupes dans la collection de sites.

Pour créer un groupe dans la collection de sites, utilisez la méthode Add .

Pour renvoyer un seul groupe à partir de la collection de groupes, utilisez un indexeur. Par exemple, en supposant que la collection est assignée à une variable nommée collGroups , utilisez collGroups[index] dans C# ou collGroups(index) dans Microsoft Visual Basic, où index est le numéro d'index du groupe dans la collection ou le nom du groupe.

Exemples

L'exemple de code suivant parcourt tous les groupes dans une collection de sites et supprime tous les groupes appartenant à l'utilisateur spécifié.

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);
    }
}

Cohérence de thread

Tous les membres statique (Partagé dans Visual Basic)s publics de ce type sont thread-safe. Cela n’est pas garanti pour les membres d’instance.

Voir aussi

Référence

SPGroupCollection - Membres

Microsoft.SharePoint - Espace de noms