SPFieldCollection.Add method (String, SPFieldType, Boolean)

發行項
05/05/2015

建立根據指定的顯示名稱、欄位型別和布林值的集合中的欄位。

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

Syntax

'宣告
Public Function Add ( _
    strDisplayName As String, _
    type As SPFieldType, _
    bRequired As Boolean _
) As String
'用途
Dim instance As SPFieldCollection
Dim strDisplayName As String
Dim type As SPFieldType
Dim bRequired As Boolean
Dim returnValue As String

returnValue = instance.Add(strDisplayName, _
    type, bRequired)

public string Add(
    string strDisplayName,
    SPFieldType type,
    bool bRequired
)

參數

strDisplayName
Type: System.String

字串，指定欄位的顯示名稱。

type
Type: Microsoft.SharePoint.SPFieldType

SPFieldType值，指定要建立欄位的型別。

bRequired
Type: System.Boolean

true如果欄位必須包含值。否則， false。

傳回值

Type: System.String
字串，包含新的欄位的內部名稱。

備註

Add方法無法用於建立的欄位型別Lookup，因為這會導致擲回SPException 。改為使用AddLookup方法來新增此型別的欄位。

Examples

下列程式碼範例會將必要的文字欄位加入指定的清單。

Dim webSite As SPWeb = SPContext.Current.Site.AllWebs("MySite")
Try
    Dim fields As SPFieldCollection = webSite.Lists("MyList").Fields

    fields.Add("MyField", Microsoft.SharePoint.SPFieldType.Text, True)
Finally
    webSite.Dispose()
End Try

using (SPWeb oWebsite = SPContext.Current.Site.AllWebs["MySite"])
{
    SPFieldCollection collFields = oWebsite.Lists["MyList"].Fields;
    collFields.Add("MyField", Microsoft.SharePoint.SPFieldType.Text, 
        true);
}

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