Clase SPGroup
Representa un grupo en un sitio Web de SharePoint Foundation .
Jerarquía de la herencia
System.Object
Microsoft.SharePoint.SPMember
Microsoft.SharePoint.SPPrincipal
Microsoft.SharePoint.SPGroup
Espacio de nombres: Microsoft.SharePoint
Ensamblado: Microsoft.SharePoint (en Microsoft.SharePoint.dll)
Sintaxis
'Declaración
Public NotInheritable Class SPGroup _
Inherits SPPrincipal
'Uso
Dim instance As SPGroup
public sealed class SPGroup : SPPrincipal
Comentarios
Utilice la propiedad Groups de la clase SPUser o SPWeb para devolver la colección de grupos para el usuario o el sitio Web. De lo contrario, utilice la propiedad OwnedGroups de la clase SPUser para devolver la colección de grupos que pertenecen a un usuario o la propiedad SiteGroups de la clase SPWeb para devolver todos los grupos en la colección de sitios.
Utilice un indizador para devolver un único grupo de la colección. Por ejemplo, si la colección se asigna a una variable denominada collGroups, use myGroups[index] en Microsoft C# o myGroups(index) en Microsoft Visual Basic, donde index es el número de índice del grupo de la colección o el nombre del grupo.
Cada grupo puede ser representado por un objeto SPMember y tiene un identificador de miembro único (vea la propiedad ID ). En el siguiente ejemplo se asigna a un grupo a un objeto SPMember :
SPMember oMember = oWebsite.SiteGroups["Cross-Site_Group_Name"];
Para obtener información general acerca de los grupos y seguridad, vea Autorización, usuarios, grupos y el modelo de objetos de SharePoint 2013.
Ejemplos
En el ejemplo de código siguiente se cambia el nombre, el propietario y la descripción de un grupo en una colección de sitios.
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();
}
Nota
Determinados objetos implementan la interfaz de IDisposable y, a continuación, se debe evitar la conservación de estos objetos en la memoria que ya no se necesitan. Para obtener información acerca de buenas prácticas de codificación, vea Disposing Objects.
Seguridad para subprocesos
Los miembros static (Shared en Visual Basic) públicos de este tipo son seguros para subprocesos. No se garantiza que los miembros de instancias sean seguros para los subprocesos.