Export (0) Print
Expand All

SPControl.GetContextWeb method

Returns the Web site that serves as context for the request.

Namespace:  Microsoft.SharePoint.WebControls
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)

public static SPWeb GetContextWeb(
	HttpContext context
)

Parameters

context
Type: System.Web.HttpContext

A System.Web.HTTPContext object, which encapsulates the HTTP-specific context that is used by the server to process site requests.

Return value

Type: Microsoft.SharePoint.SPWeb
A Microsoft.SharePoint.SPWeb object that represents the Web site.

  • The GetContextWeb 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 GetContextWeb method returns the SPWeb 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 SPWeb class to close the object returned through the GetContextWeb method. Instead let Windows SharePoint Services or your portal application manage the object.

For more information, see Establishing Site Context .

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

[Visual Basic .NET]
<% Dim siteCollection As SPSite = SPControl.GetContextSite(Context)
Dim site As SPWeb = SPControl.GetContextWeb(Context) %>
[C#]
<% SPSite siteCollection = SPControl.GetContextSite(Context); 
   SPWeb site = SPControl.GetContextWeb(Context); %>

Show:
© 2014 Microsoft