Share via


SPField.SchemaXml Property

Gets or sets the schema that defines the field.

Namespace:  Microsoft.SharePoint
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Available in Sandboxed Solutions: Yes
Available in SharePoint Online

Syntax

'Declaration
<ClientCallableAttribute> _
<ClientCallableConstraintAttribute(FixedId := "validstr", Type := ClientCallableConstraintType.Custom,  _
    Value := "It MUST be an XML document that conforms to the FieldDefinition type as defined in [MS-WSSCAML] document or a string that is null or empty.")> _
Public Property SchemaXml As String
    Get
    Set
'Usage
Dim instance As SPField
Dim value As String

value = instance.SchemaXml

instance.SchemaXml = value
[ClientCallableAttribute]
[ClientCallableConstraintAttribute(FixedId = "validstr", Type = ClientCallableConstraintType.Custom, Value = "It MUST be an XML document that conforms to the FieldDefinition type as defined in [MS-WSSCAML] document or a string that is null or empty.")]
public string SchemaXml { get; set; }

Property Value

Type: System.String
A Collaborative Application Markup Language (CAML) string that contains the schema.

Remarks

Do not call the Update method when using the SchemaXml property to modify a field.

Using this property to set a read-only attribute, such as InternalName, generates an exception.

See Also

Reference

SPField Class

SPField Members

Microsoft.SharePoint Namespace