SPGroup class

Representa um grupo em um site SharePoint Foundation .

Inheritance hierarchy

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

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

Syntax

'Declaração
Public NotInheritable Class SPGroup _
    Inherits SPPrincipal
'Uso
Dim instance As SPGroup

public sealed class SPGroup : SPPrincipal

Comentários

Use a propriedade Groups da classe SPUser ou 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 a coleção de grupos pertencentes a um usuário ou a propriedade SiteGroups da classe SPWeb para retornar todos os grupos no conjunto de sites.

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

Cada grupo pode ser representado por um objeto SPMember e tem um identificador de membro exclusivo (consulte a propriedade ID ). O exemplo a seguir atribui um grupo a um objeto de SPMember :

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

Para obter informações gerais sobre grupos e segurança, consulte Users, Groups, and Authorization.

Examples

O exemplo de código a seguir altera o nome, o proprietário e a descrição de um grupo em um conjunto 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();
}

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

SPGroup members

Microsoft.SharePoint namespace