SPWeb.ApplyWebTemplate Method (String) (Microsoft.SharePoint)

ApplyWebTemplate Method (String)

Switch on low bandwidth view

Community Content

In this section

Statistics Annotations (0)

Click here to expand

Collapse All

Language Filter

SPWeb.ApplyWebTemplate Method (String) (Microsoft.SharePoint)

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

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

Syntax

Visual Basic (Declaration)

Public Sub ApplyWebTemplate ( _
    strWebTemplate As String _
)

Visual Basic (Usage)

Dim instance As SPWeb
Dim strWebTemplate As String

instance.ApplyWebTemplate(strWebTemplate)

public void ApplyWebTemplate (
    string strWebTemplate
)

Parameters

strWebTemplate: A string that contains the name of the site definition or the file name of the site template, including the .stp extension.

Remarks

Caution:
Be careful about calling the ApplyWebTemplate method within a Web site 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 Web sites.

Caution:

Be careful about calling the ApplyWebTemplate method within a Web site 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 Web sites.

Example

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

Visual Basic

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 Best Practices: Using Disposable Windows SharePoint Services Objects.

Reference

SPWeb Class
SPWeb Members
Microsoft.SharePoint Namespace