PortalContext Class
The PortalContext class provides runtime support for a portal site.
System.Object
Microsoft.SharePoint.Portal.PortalContext
Public Methods
The following table shows the methods of the PortalContext class and a brief description of each.
| Name | Description |
|---|---|
| GetMappedUrl(String) | Gets the context-sensitive URL for the specified canonical URL. |
Public Properties
The following table shows the properties of the PortalContext class, the data type of each property, and a brief description of each.
| Name | Data Type | Description |
|---|---|---|
| CentralSiteUrl | String | Gets the URL of the central portal site. This property uses the URL mapping table to return a context-sensitive URL based on the request URL, if available. |
| Current | Microsoft.SharePoint.Portal.PortalContext | Gets the instance of PortalContext that represents the current application context. This property throws an InvalidOperationException exception if System.Web.HttpContext.Current property is null. |
| FromAddress | String | Gets the From address used for e-mail notifications. |
| IsFederated | Boolean | Gets a flag that indicated whether this portal site is federated. |
| IsPersonalPortal | Boolean | Gets a flag that indicates whether this portal site hosts personal sites. |
| JobServerAddress | String | Gets the address of the job server. |
| LocalSearchApplicationName | String | Gets the name of the local search application for this portal site. |
| MailEncoding | System.Text.Encoding | Gets the encoding type used for e-mail message bodies. |
| PersonalPortalUrl | String | Gets the URL of a personal portal site. |
| ReplyToAddress | String | Gets the Reply-To address used for e-mail notifications. |
| SearchApplicationName | String | Gets the name of the search application for this portal site. |
| SiteId | System.Guid | Gets the globally unique identifier (GUID) of this portal site. |
| SiteUrl | String | Gets the URL of this portal site. |
| SiteUrlPath | String | Gets the relative root path of the front-end Web server. |
| SmtpServerAddress | String | Gets the address of the SMTP server associated with this portal site. |
| WorkspaceUrl | String | Gets the URL of the document workspace associated with the portal site. |
| Zone | Microsoft.SharePoint.Portal.PortalZone | Gets a PortalZone value that indicates the zone of this portal site. |
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.
Requirements
Namespace: Microsoft.SharePoint.Portal
Platforms: Windows Server 2003
Assembly: Microsoft.SharePoint.Portal (in Microsoft.SharePoint.Portal.dll)
Security: Code Access Security