Share via


DocumentService Class

The DocumentService class represents a component that manages DocumentWorkspace objects in the topology of the server farm.

System.Object

    Microsoft.SharePoint.Portal.Topology.Service

       Microsoft.SharePoint.Portal.Topology.DocumentService

Public Constructors

The following table shows the constructors of the DocumentService class and a brief description of each.

Name Description
DocumentService Initializes a new instance of the DocumentService class based on the specified Server object.

Public Properties

The following table shows the properties of the DocumentService class, the data type of each property, and a brief description of each.

Name Data type Description
DocumentWorkspaces Microsoft.SharePoint.Portal.Topology.DocumentWorkspaceCollection Gets a collection of DocumentWorkspace objects managed by the DocumentService class.
IsSSLEnabled Property Gets or sets a Boolean value that indicates whether Secure Sockets Layer (SSL) is implemented for use with the DocumentService 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

The public constant ServiceClass defined in the DocumentService class contains the GUID value that distinguishes a DocumentService from other Microsoft Office SharePoint Portal Server 2003 services.

Use the DocumentService class to specify information about DocumentWorkspace objects in the topology of the server farm.

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