Share via


AreaGroupCollection Class

NOTE: This API is now obsolete.

Manages area groups.

Inheritance Hierarchy

System.Object
  Microsoft.SharePoint.Portal.SiteData.AreaGroupCollection

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

Syntax

'Declaration
<ObsoleteAttribute("This class is obsolete.")> _
<SharePointPermissionAttribute(SecurityAction.InheritanceDemand, ObjectModel := True)> _
<SharePointPermissionAttribute(SecurityAction.Demand, ObjectModel := True)> _
Public Class AreaGroupCollection _
    Implements IEnumerable
'Usage
Dim instance As AreaGroupCollection
[ObsoleteAttribute("This class is obsolete.")]
[SharePointPermissionAttribute(SecurityAction.InheritanceDemand, ObjectModel = true)]
[SharePointPermissionAttribute(SecurityAction.Demand, ObjectModel = true)]
public class AreaGroupCollection : IEnumerable

Remarks

The order of the groups in the collection is the order of the groups as they appear in the area.

Examples

The following code example shows the use of the AreaGroupCollection class.

// Get the default group.
AreaGroupCollection groupsTopics = areaTopics.Groups;

// Add a new group.
int idNewGroup = groupsTopics.Add("NewGroup");

// Iterate over the groups and remove the new one.
foreach (AreaGroup group in groupsTopics)
{
if (idNewGroup == group.GroupID)
  {
  groupsTopics.Remove(group);
   break;
  }
}

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.

See Also

Reference

AreaGroupCollection Members

Microsoft.SharePoint.Portal.SiteData Namespace