SPGroup - Classe

Représente un groupe sur un site Web de SharePoint Foundation .

Hiérarchie d’héritage

System.Object
  Microsoft.SharePoint.SPMember
    Microsoft.SharePoint.SPPrincipal
      Microsoft.SharePoint.SPGroup

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

Syntaxe

'Déclaration
Public NotInheritable Class SPGroup _
    Inherits SPPrincipal
'Utilisation
Dim instance As SPGroup

public sealed class SPGroup : SPPrincipal

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 la collection des groupes appartenant à un utilisateur, ou la propriété SiteGroups de la classe SPWeb pour renvoyer tous les groupes dans la collection de sites.

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

Chaque groupe peut être représentée par un objet SPMember et dispose d'un identificateur de membre unique (consultez la propriété ID ). L'exemple suivant assigne un groupe à un objet SPMember :

SPMember oMember = oWebsite.SiteGroups["Cross-Site_Group_Name"];

Pour obtenir des informations générales sur les groupes et la sécurité, consultez Autorisation, utilisateurs, groupes et modèle objet dans SharePoint 2013.

Exemples

L'exemple de code suivant modifie le nom, le propriétaire et la description d'un groupe dans une collection de sites.

Dim webSite As SPWeb = SPContext.Current.Site.RootWeb
Try
    Dim myGroup As SPGroup = webSite.SiteGroups("Original_Name")
            
    myGroup.Name = "New_Name"
    myGroup.Owner = webSite.Users("Domain_Name\User")
    myGroup.Description = "Description"
            
    myGroup.Update()
Finally
    webSite.Dispose()
End Try

using (SPWeb oWebsite = SPContext.Current.Site.RootWeb)
{
    SPGroup oGroup = oWebsite.SiteGroups["Original_Name"];
    oGroup.Name = "New_Name";
    oGroup.Owner = oWebsite.Users["Domain_Name\\User"];
    oGroup.Description = "Description";
    oGroup.Update();
}

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

SPGroup - Membres

Microsoft.SharePoint - Espace de noms