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)
Available in Sandboxed Solutions: Yes
Available in SharePoint Online
Syntax
'Declaration
<ClientCallableAttribute> _
Public Sub ApplyWebTemplate ( _
strWebTemplate As String _
)
'Usage
Dim instance As SPWeb
Dim strWebTemplate As String
instance.ApplyWebTemplate(strWebTemplate)
[ClientCallableAttribute]
public void ApplyWebTemplate(
string strWebTemplate
)
Parameters
strWebTemplate
Type: System.StringThe name of the site definition or the file name of the site template to be applied.
Exceptions
| Exception | Condition |
|---|---|
| SPException | The website is write-locked or read-only. |
Remarks
Warning
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.
Examples
The following code example applies a specified site template to a subsite in the current site collection.
Using webSite As SPWeb = SPContext.Current.Site.OpenWeb("Website_URL")
webSite.ApplyWebTemplate("File_Name.stp")
End Using
using (SPWeb oWebsite = SPContext.Current.Site.OpenWeb("Website_URL"))
{
oWebsite.ApplyWebTemplate("File_Name.stp");
}
Note
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.