GetContextSite Method

  • Article

The GetContextSite method of the SPControl class returns the site collection that serves as context for the request.

Parameters

Return Value

A Microsoft.SharePoint.SPSite object that represents the site collection.

Remarks

The GetContextSite method is used in code running within an HTTP context that is integrated with a Windows SharePoint Services deployment. The code can be used in a Web Part, in a custom Web service (in _vti_bin), or in an ASPX page or Web Application (in _layouts). In each of these cases, the solution is available to any SharePoint site on the front-end Web server, and the GetContextSite method returns the SPSite object for the current HTTP request. For example, a custom ASPX page (_layouts/1033/MyItems.aspx) that returns all list items created by the user accessing the page would be available for use in all sites on the Web server by browsing to URLs like the following:

  • http://Server_Name/_layouts/1033/MyItems.aspx
  • http://Server_Name/sites/Site_Collection/_layouts/1033/MyItems.aspx
  • http://Server_Name/Subsite/_layouts/1033/MyItems.aspx

Do not use the Dispose or Close method of the SPSite class to close the object returned through the GetContextSite method. Instead let Windows SharePoint Services or your portal application manage the object.

For more information, see Establishing Site Context.

Example

The following code example uses the GetContextSite method in conjunction with the GetContextWeb method to return both a site collection object and a site object on an .aspx page.

Requirements

Platforms: Microsoft Windows Server 2003

Security: Code Access Security