Clase SPGroupCollection
Representa una colección de objetos SPGroup .
Jerarquía de la herencia
System.Object
Microsoft.SharePoint.Administration.SPAutoSerializingObject
Microsoft.SharePoint.SPBaseCollection
Microsoft.SharePoint.SPMemberCollection
Microsoft.SharePoint.SPGroupCollection
Espacio de nombres: Microsoft.SharePoint
Ensamblado: Microsoft.SharePoint (en Microsoft.SharePoint.dll)
Sintaxis
'Declaración
Public Class SPGroupCollection _
Inherits SPMemberCollection
'Uso
Dim instance As SPGroupCollection
public class SPGroupCollection : SPMemberCollection
Comentarios
Utilice la propiedad Groups de la clase de SPUser o de la clase 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 los 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.
Para crear un grupo en la colección de sitios, use el método Add .
Utilice un indizador para devolver un único grupo de la colección de grupos. Por ejemplo, suponiendo que la colección se asigna a una variable denominada collGroups , use collGroups[index] en C# o collGroups(index) en Microsoft Visual Basic, donde index es el número de índice del grupo de la colección o el nombre del grupo.
Ejemplos
En el ejemplo de código siguiente se recorre en iteración todos los grupos de una colección de sitios y elimina todos los grupos que pertenecen al usuario especificado.
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);
}
}
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.