SPWeb.ApplyWebTemplate method (SPWebTemplate)

發行項
05/05/2015

會指定的站台定義物件或站台範本物件套用到不已套用到任何範本的網站。

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

Syntax

'宣告
Public Sub ApplyWebTemplate ( _
    webTemplate As SPWebTemplate _
)
'用途
Dim instance As SPWeb
Dim webTemplate As SPWebTemplate

instance.ApplyWebTemplate(webTemplate)

public void ApplyWebTemplate(
    SPWebTemplate webTemplate
)

參數

webTemplate
Type: Microsoft.SharePoint.SPWebTemplate

網站定義或要套用網站範本中。

Exceptions

Exception	Condition
ArgumentNullException	webTemplate是 null 。

備註

這個方法會呼叫ApplyWebTemplate(String)方法，使用webTemplate參數的 [ Name ] 屬性。

注意

請小心有關呼叫這個方法內的網站佈建回呼函式。如果您呼叫這個方法內定義在相同的站台定義組態所套用的佈建回呼函式，您可能會造成無限迴圈。相反地，建立兩種類似站台定義的組態中的站台定義，另一個則是看得見，一個隱藏的。設定可以再包含佈建的組件回呼函式，會隱藏的設定套用至網站。

Examples

下列程式碼範例將指定的站台範本物件套用於目前的網站集合中的子網站。

Dim siteCollection As SPSite = SPContext.Current.Site
Using webSite As SPWeb = siteCollection.OpenWeb("Website_URL")
    Dim webTemplates As SPWebTemplateCollection = 
        siteCollection.GetCustomWebTemplates(Locale_ID)
    Dim webTemplate As SPWebTemplate = webTemplates("Template_Name")
    webSite.ApplyWebTemplate(webTemplate)
End Using

SPSite oSiteCollection = SPContext.Current.Site;
using(SPWeb oWebsite = oSiteCollection.OpenWeb("Website_URL"))
{
    SPWebTemplateCollection collWebTemplates = oSiteCollection.GetCustomWebTemplates(Locale_ID);
    SPWebTemplate oWebTemplate = collWebTemplates["Template_Name"];

    oWebsite.ApplyWebTemplate(oWebTemplate);
}

注意事項
某些物件實作IDisposable介面，並且您必須避免之後不再需要保留這些物件在記憶體中。良好的程式碼撰寫方式的相關資訊，請參閱Disposing Objects。