PortalSite Class
The PortalSite class represents an instance of a portal site.
System.Object
Microsoft.SharePoint.Portal.Topology.TopologyObjectBase
Microsoft.SharePoint.Portal.Topology.PortalSite
Public Constructors
The following table shows the constructors of the PortalSite class and a brief description of each.
| Name | Description |
|---|---|
| PortalSite | Initializes a new instance of the PortalSite class based on the specified TeamSite instance, URL, component settings database, and profile database. |
| PortalSite | Initializes a new instance of the PortalSite class based on the specified TeamSite instance, default application pool, URL, component settings database, and profile database. |
| PortalSite | Initializes a new instance of the PortalSite class based on the specified TeamSite instance, default application pool, URL, component settings database, profile database, and DocumentWorkspace object. Reserved for internal use only. |
Public Methods
The following table shows the methods of the PortalSite class and a brief description of each.
| Name | Description |
|---|---|
| Commit(Boolean) | Persists changes made to the properties of a portal site. |
| GetExtendedStatus(Microsoft.SharePoint.Portal.Topology.TopologyObjectBase) | Reserved for internal use only. |
| PrepareForBackup | Prepares a portal site for backup. |
| Restore(String, System.Uri, String, String, String, String, String, String, String[], String[], String[], Boolean[]) | Restores a portal site from a previous backup. |
Public Properties
The following table shows the properties of the PortalSite class, the data type of each property, and a brief description of each.
| Name | Data type | Description |
|---|---|---|
| DocumentWorkspace | Microsoft.SharePoint.Portal.Topology.DocumentWorkspace | Gets or sets the Document Workspace site associated with a portal site. |
| IsCentral | Boolean | Gets a value that specifies whether the portal site is a parent portal site that provides shared services for other portal sites. |
| IsFederated | Boolean | Gets a value that specifies whether the portal site is a child portal site that uses the shared services of a parent portal site. |
| SearchApplicationName | String | Gets the name of the instance of Microsoft SharePoint Portal Server Search (SharePointPSSearch) service used by the portal site. |
| ServiceDatabase | Microsoft.SharePoint.Portal.Topology.Database | Gets or sets the name of the component settings database used by the portal site. |
| SiteDatabase | Microsoft.SharePoint.Portal.Topology.Database | Gets or sets the name of the content database used by the portal site. |
| TeamSite | Microsoft.SharePoint.Portal.Topology.TeamSite | Gets the name of the base SharePoint site on which the portal site is based. |
| Url | String | Gets or sets the absolute URL of the portal site. |
| UrlPath | String | Gets the relative URL of the portal site. |
| UserProfileDatabase | Microsoft.SharePoint.Portal.Topology.Database | Gets or sets the name of the profile database used by the portal site. |
| VirtualServer | Microsoft.SharePoint.Portal.Topology.VirtualServer | Gets the name of the virtual server that hosts the portal site. |
Thread Safety
Any public static (Shared in Visual Basic) members of this type are safe for multithreaded operations. Instance members are not guaranteed to be thread safe.
Remarks
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