SPListCollection.Add method (String, String, SPListTemplateType)

發行項
05/05/2015

建立清單以指定的標題、描述及清單定義型別。

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

Syntax

'宣告
Public Overridable Function Add ( _
    title As String, _
    description As String, _
    templateType As SPListTemplateType _
) As Guid
'用途
Dim instance As SPListCollection
Dim title As String
Dim description As String
Dim templateType As SPListTemplateType
Dim returnValue As Guid

returnValue = instance.Add(title, description, _
    templateType)

public virtual Guid Add(
    string title,
    string description,
    SPListTemplateType templateType
)

參數

title
Type: System.String

字串，包含標題。

description
Type: System.String

字串，包含描述。

templateType
Type: Microsoft.SharePoint.SPListTemplateType

列舉值，指定清單定義的型別。

傳回值

Type: System.Guid
System.Guid用來識別新的清單。

備註

Add方法的這個多載只適用於Microsoft.SharePoint.SPListTemplateType列舉型別由預設Microsoft SharePoint Foundation清單範本。若要建立其他的清單範本為基礎的清單，請使用其中一個其他Add方法多載。

Examples

下列程式碼範例會在目前的網站集合內每個網站中建立連絡人清單。

Dim site As SPSite = SPControl.GetContextSite(Context)
Dim destSites As SPWebCollection = site.AllWebs
Dim destSite As SPWeb

For Each destSite In  destSites

    Dim destLists As SPListCollection = destSite.Lists

    destLists.Add("New_List_Name", "List_Description", 
        SPListTemplateType.Contacts) 

Next destSite

SPSite oSiteCollection = SPContext.Current.Site;
using(SPWebCollection collWebsites = oSiteCollection.AllWebs)
{
    foreach (SPWeb oWebsite in collWebsites)
    {
        SPListCollection collList = oWebsite.Lists;
        collList.Add("New_List_Name", "List_Description",
            SPListTemplateType.Contacts);
    }
}

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