SPFieldCollection.Add 方法 (String, SPFieldType, Boolean)

项目
05/13/2015

根据指定的显示名称、字段类型和布尔值的集合中创建一个字段。

命名空间： Microsoft.SharePoint
程序集： Microsoft.SharePoint（位于 Microsoft.SharePoint.dll 中）

语法

声明
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
类型：System.String

一个字符串，指定该字段的显示名称。

type
类型：Microsoft.SharePoint.SPFieldType

一个SPFieldType值，指定要创建的字段类型。

bRequired
类型：System.Boolean

true如果字段必须包含一个值；否则为false。

返回值

类型：System.String
一个字符串，包含新字段的内部名称。

备注

不能使用Add方法来创建的字段类型Lookup，因为这将导致引发SPException 。而是使用AddLookup方法中添加这种类型的字段。

示例

下面的代码示例添加到列表中指定必需的文本字段。

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。