SPGroup-Klasse

Stellt eine Gruppe auf einer Website SharePoint Foundation dar.

Vererbungshierarchie

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

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

Syntax

'Declaration
Public NotInheritable Class SPGroup _
    Inherits SPPrincipal
'Usage
Dim instance As SPGroup
public sealed class SPGroup : SPPrincipal

Hinweise

Verwenden Sie die Groups -Eigenschaft der SPUser oder SPWeb -Klasse, um die Auflistung der Gruppen für den Benutzer oder einer Website zurückzugeben. Verwenden Sie andernfalls die OwnedGroups -Eigenschaft der SPUser -Klasse, um die Auflistung von Gruppen im Besitz eines Benutzers zurückzugeben, oder die SiteGroups -Eigenschaft der SPWeb -Klasse, um alle Gruppen in der Websitesammlung zurückzugeben.

Verwenden Sie Indexer, um eine einzelne Gruppe aus der Auflistung zurückzugeben. Verwenden Sie beispielsweise, wenn die Auflistung einer Variablen mit dem Namen collGroupszugewiesen ist, myGroups[index] in Microsoft C#- oder myGroups(index) in Microsoft Visual Basic, wobei index entweder die Indexnummer der Gruppe in der Auflistung oder der Name der Gruppe ist.

Jede Gruppe von einem SPMember -Objekt dargestellt werden kann und verfügt über eine eindeutige Element-ID (siehe ID -Eigenschaft). Im folgenden Beispiel wird ein Objekt SPMember eine Gruppe zugewiesen:

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

Allgemeine Informationen zu Gruppen und Sicherheit finden Sie unter Autorisierung, Benutzer, Gruppen und das Objektmodell in SharePoint 2013.

Beispiele

Im folgenden Codebeispiel wird ändert sich der Name, den Besitzer und die Beschreibung einer Gruppe in einer Websitesammlung.

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

Hinweis

Bestimmte Objekte, die IDisposable -Schnittstelle implementieren, und müssen Sie vermeiden, diese Objekte im Arbeitsspeicher beibehalten, wenn sie nicht mehr benötigt werden. Informationen zu bewährten Codierung finden Sie unter Disposing Objects.

Threadsicherheit

Alle öffentlichen static (Shared in Visual Basic) Member dieses Typs sind threadsicher. Die Threadsicherheit von Instanzmembern ist nicht gewährleistet.

Siehe auch

Referenz

SPGroup-Member

Microsoft.SharePoint-Namespace