SPGroup 类

代表SharePoint Foundation网站上的组。

继承层次结构

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

命名空间:  Microsoft.SharePoint
程序集:  Microsoft.SharePoint(位于 Microsoft.SharePoint.dll 中)

语法

声明
Public NotInheritable Class SPGroup _
    Inherits SPPrincipal
用法
Dim instance As SPGroup
public sealed class SPGroup : SPPrincipal

备注

使用SPUserSPWeb类的Groups属性可返回的用户或网站的组的集合。否则,使用要返回的用户所拥有的组的集合的SPUser类的OwnedGroups属性或SPWeb类的SiteGroups属性返回在网站集中的所有组。

使用索引器从集合中返回单个组。例如,如果集合分配给名为collGroups的变量中,使用myGroups[index]在 Microsoft C# 中或myGroups(index)在 Microsoft Visual Basic 中,其中index是集合中的组的索引号或组的名称。

每个组可以由SPMember对象,并且有一个唯一的成员标识符 (请参阅ID属性)。下面的示例将一组分配对SPMember对象:

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

For general information about groups and security, see SharePoint 2013 中的授权、用户、组和对象模型.

示例

下面的代码示例更改名称、 所有者和网站集中的组的说明。

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

备注

Certain objects implement the IDisposable interface, and you must avoid retaining these objects in memory after they are no longer needed. For information about good coding practices, see Disposing Objects.

线程安全性

该类型的任何公共 静态 (已共享 在 Visual Basic 中) 成员都是线程安全的。不保证任何实例成员都是线程安全的。

另请参阅

引用

SPGroup 成员

Microsoft.SharePoint 命名空间