DocumentWorkspaceCollection Class
The DocumentWorkspaceCollection class represents a collection of DocumentWorkspace objects in the topology of a server farm.
System.Object
Microsoft.SharePoint.Portal.Topology.SqlCollectionBase
Microsoft.SharePoint.Portal.Topology.TopologyObjectCollectionBase
Microsoft.SharePoint.Portal.Topology.DocumentWorkspaceCollection
Public Constructors
The following table shows the constructors of the DocumentWorkspaceCollection class and a brief description of each.
| Name | Description |
|---|---|
| DocumentWorkspaceCollection(Microsoft.SharePoint.Portal.Topology.TopologyManager, Microsoft.SharePoint.Portal.Topology.Service) | Reserved for internal use only. |
Public Methods
The following table shows the public methods of the DocumentWorkspaceCollection class and a brief description of each.
| Name | Description |
|---|---|
| Add(Microsoft.SharePoint.Portal.Topology.DocumentWorkspace) | Adds the specified DocumentWorkspace object to the topology of the server farm. |
| Remove(System.Guid) | Removes the specified DocumentWorkspace object from the topology of the server farm. |
Protected Methods
The following table shows the protected methods of the DocumentWorkspaceCollection class and a brief description of each.
| Name | Description |
|---|---|
| CreateSqlCollectionItem(System.Data.SqlClient.SqlDataReader) | Populates the values of the properties of a DocumentWorkspace object from a row in the configuration database and returns the DocumentWorkspace object. |
| InitializeSqlCollection | Returns a collection of existing DocumentWorkspace objects. |
Public Properties
The following table shows the properties of the DocumentWorkspaceCollection class, the data type of each property, and a brief description of each.
| Name | Data Type | Description |
|---|---|---|
| Item(System.Guid) | Microsoft.SharePoint.Portal.Topology.DocumentWorkspace | Gets a DocumentWorkspace object. |
Thread Safety
Any public static (Shared in Visual Basic) members of this type are safe for multithreaded operations. Any instance members are not guaranteed to be thread safe.
Remarks
Use the DocumentWorkspaceCollection to manage DocumentWorkspace objects in the topology of a server farm. The DocumentWorkspaceCollection corresponds to the list of DocumentWorkspace objects listed in the PortalWorkspaces table of the configuration database.
Deriving from this class is not supported.
To use the properties and methods of the objects in the Topology namespace you must be a member of the local STS_WPG and SPS_WPG security groups, and a member of the db_owner database role for the configuration database.
In addition, for certain methods, such as those that create a portal site, you must be a member of the local Administrators group, and have membership in the Database Creators and Security Administrators server roles in the SQL Server instance that hosts the configuration database.
Requirements
Namespace: Microsoft.SharePoint.Portal.Topology
Platforms: Microsoft Windows Server 2003
Assembly: Microsoft.SharePoint.Portal (in Microsoft.SharePoint.Portal.dll)
Security: Code Access Security