AddFieldAsXml method (String)
Collapse the table of content
Expand the table of content

SPFieldCollection.AddFieldAsXml method (String)

Creates a field based on the specified schema.

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

'Declaration
Public Function AddFieldAsXml ( _
	strXml As String _
) As String
'Usage
Dim instance As SPFieldCollection
Dim strXml As String
Dim returnValue As String

returnValue = instance.AddFieldAsXml(strXml)

Parameters

strXml
Type: System.String

A Collaborative Application Markup Language (CAML) string that contains the schema.

Return value

Type: System.String
A CAML string that contains the name of the new field.

The following code example uses CAML to define a field and adds the field to the specified list.

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

    Dim newField As String = "<Field Type=""Calculated"" " + 
    "DisplayName=""New_Field_Display_Name"" ResultType=""Currency"" " + 
    "ReadOnly=""TRUE"" Name=""New_Field_Internal_Name"">" + 
    "<Formula>=Currency_Field_Name*100</Formula>" + 
    "<FieldRefs><FieldRef Name=""Currency_Field_Name"" />" + 
    "</FieldRefs></Field>"

    fields.AddFieldAsXml(newField)
Finally
    webSite.Dispose()
End Try
NoteNote

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 Disposing Objects.

Show:
© 2016 Microsoft