SPWeb.ApplyWebTemplate method (String)

Applies the specified site definition or site template to the website that has no template applied to it.

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

public void ApplyWebTemplate(
	string strWebTemplate
)

Parameters

strWebTemplate
Type: System.String

The name of the site definition or the file name of the site template to be applied.

ExceptionCondition
SPException

The website is write-locked or read-only.

Caution noteCaution

Be careful about calling this method within a website provisioning callback function. If you call this method inside a provisioning callback that is defined within the same site definition configuration that is being applied, you can cause an infinite loop. Instead, create two similar site definition configurations within the site definition, one that is visible and one that is hidden. The visible configuration can then contain a provisioning assembly callback that applies the hidden configuration to websites.

The following code example applies a specified site template to a subsite in the current site collection.

using (SPWeb oWebsite = SPContext.Current.Site.OpenWeb("Website_URL"))
{
    oWebsite.ApplyWebTemplate("File_Name.stp");
}
NoteNote

Certain objects implement the IDisposable interface, and you must avoid retaining these objects in memory after they are no longer needed. For information about good coding practices, see Disposing Objects.

Show: