FieldCollection.SchemaXml property

Article
03/05/2018

Specifies the XML schema of the collection of fields.

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

Syntax

'Declaration
Public ReadOnly Property SchemaXml As String
    Get
'Usage
Dim instance As FieldCollection
Dim value As String

value = instance.SchemaXml

public string SchemaXml { get; }

Property value

Type: System.String
Returns String.

Exceptions

Exception	Condition
[System.UnauthorizedAccessException]	The current user has insufficient permissions. Error code: - 2147024891.

Remarks

It must not be a null reference (Nothing in Visual Basic). It must not be empty. It must be an XML document that conforms to the FieldDefinitions type.

A field definition describes the structure and format of a field that is used within a list or content type.

Schema

<xs:complexType name="FieldDefinition" mixed="true">
    <xs:all>
      <xs:element name="CHOICES" type="CHOICEDEFINITIONS" minOccurs="0" maxOccurs="1" />
      <xs:element name="Customization" minOccurs="0" maxOccurs="1">
          <xs:complexType>
              <xs:sequence>
                  <xs:any minOccurs="1" maxOccurs="1" namespace="##any" processContents="skip" />
              </xs:sequence>
          </xs:complexType>
      </xs:element>
      <xs:element name="Default" type="xs:string" minOccurs="0" maxOccurs="1" />
      <xs:element name="DefaultFormula" type="xs:string" minOccurs="0" maxOccurs="1" />
      <xs:element name="DisplayBidiPattern" minOccurs="0" maxOccurs="1">
        <xs:complexType>
          <xs:sequence>
            <xs:any minOccurs="0" maxOccurs="unbounded" namespace="##any" processContents="skip" />
          </xs:sequence>
          <xs:anyAttribute processContents="skip" />
        </xs:complexType>
      </xs:element>
      <xs:element name="DisplayPattern" minOccurs="0" maxOccurs="1">
        <xs:complexType>
          <xs:sequence>
            <xs:any minOccurs="0" maxOccurs="unbounded" namespace="##any" processContents="skip" />
          </xs:sequence>
          <xs:anyAttribute processContents="skip" />
        </xs:complexType>
      </xs:element>
      <xs:element name="FieldRefs" minOccurs="0" maxOccurs="1"> 
        <xs:complexType mixed="true">
          <xs:sequence>
            <xs:element name="FieldRef" type="FieldRefDefinitionField" minOccurs="0" maxOccurs="unbounded" />
          </xs:sequence>
        </xs:complexType>
      </xs:element>     
      <xs:element name="Formula" type="xs:string" minOccurs="0" maxOccurs="1" />
      <xs:element name="MAPPINGS" type="MAPPINGDEFINITIONS" minOccurs="0" maxOccurs="1" />
      <xs:element name="ParserRefs" type="FieldParserRefs" minOccurs="0" maxOccurs="1" />
      <xs:element name="Validation" minOccurs="0" maxOccurs="1">
        <xs:complexType>
          <xs:sequence>
            <xs:any minOccurs="0" maxOccurs="unbounded" namespace="##any" processContents="skip" />
          </xs:sequence>
          <xs:anyAttribute processContents="skip" />
        </xs:complexType>
      </xs:element>
    </xs:all>
    <xs:attribute name="Aggregation" type="FieldAggregationAttribute" default="first"/>
    <xs:attribute name="aggregation" type="xs:string" />
    <xs:attribute name="AllowDeletion" type="TRUEFALSE" default="TRUE" />
    <xs:attribute name="AllowDuplicateValues" type="TRUEFALSE" default="TRUE" />
    <xs:attribute name="AllowHyperlink" type="TRUEFALSE" default="FALSE" />
    <xs:attribute name="AllowMultiVote" type="TRUEFALSE" default="FALSE" />
    <xs:attribute name="AppendOnly" type="TRUEFALSE" default="FALSE" />
    <xs:attribute name="AuthoringInfo" type="xs:string" default=""/>
    <xs:attribute name="BaseRenderingType" type="FieldInternalType" />
    <xs:attribute name="BaseType" type="FieldInternalType" default="Text" />
    <xs:attribute name="Calculated" type="xs:string" />
    <xs:attribute name="CalType" type="xs:int" />
    <xs:attribute name="CalendarType" type="xs:int" />
    <xs:attribute name="CAMLRendering" type="TRUEFALSE" default="FALSE" />
    <xs:attribute name="CanToggleHidden" type="TRUEFALSE" default="FALSE" />
    <xs:attribute name="CountRelated" type="TRUE_If_Present" default="FALSE" />
    <xs:attribute name="ClassInfo" type="xs:string" default="" />
    <xs:attribute name="ColName" type="xs:string" />
    <xs:attribute name="ColName2" type="xs:string" />
    <xs:attribute name="Commas" type="TRUEFALSE" />
    <xs:attribute name="Customization" type="xs:string" />
    <xs:attribute name="Decimals" type="xs:int" default="-1"/>
    <xs:attribute name="DefaultURLDesc" type="xs:string" />
    <xs:attribute name="Description" type="xs:string" />
    <xs:attribute name="Direction" type="TextDirection" default="none" />
    <xs:attribute name="Dir" type="xs:string" />
    <xs:attribute name="DisplaceOnUpgrade" type="TRUEFALSE" default="FALSE" />
    <xs:attribute name="DisplayImage" type="xs:string" />
    <xs:attribute name="DisplayName" type="xs:string" />
    <xs:attribute name="DisplayNameSrcField" type="xs:string" />
    <xs:attribute name="DisplaySize" type="xs:int" />
    <xs:attribute name="Div" type="xs:string" default="1.0" />
    <xs:attribute name="EnableLookup" type="TRUEFALSE" default="FALSE" />
    <xs:attribute name="ExceptionImage" type="xs:string" />
    <xs:attribute name="FieldRef" type="xs:string" />
    <xs:attribute name="FillInChoice" type="TRUEFALSE" default="FALSE" />
    <xs:attribute name="Filterable" type="TRUEFALSE" default="TRUE" />
    <xs:attribute name="FilterableNoRecurrence" type="TRUEFALSE" default="FALSE" />
    <xs:attribute name="ForcedDisplay" type="xs:string" />
    <xs:attribute name="ForcePromoteDemote" type="TRUE_If_Present" />
    <xs:attribute name="Format" type="xs:string" />
    <xs:attribute name="FromBaseType" type="TRUEFALSE" default="FALSE" />
    <xs:attribute name="GridEndNum" type="xs:int" />
    <xs:attribute name="GridNATxt" type="xs:string" default="" />
    <xs:attribute name="GridStartNum" type="IntPositive" />
    <xs:attribute name="GridTxtRng1" type="xs:string" default="" />
    <xs:attribute name="GridTxtRng2" type="xs:string" default="" />
    <xs:attribute name="GridTxtRng3" type="xs:string" default="" />
    <xs:attribute name="Group" type="xs:string" />
    <xs:attribute name="HeaderImage" type="xs:string" />
    <xs:attribute name="Height" type="xs:int" />
    <xs:attribute name="Hidden" type="TRUEFALSE" default="FALSE" />
    <xs:attribute name="ID" type="UniqueIdentifierWithOrWithoutBraces" />
    <xs:attribute name="Id" type="xs:string" />
    <xs:attribute name="IMEMode" type="IMEMode" />
    <xs:attribute name="Indexed" type="TRUEFALSE" default="FALSE" />
    <xs:attribute name="ImnHeader" type="xs:string" />
    <xs:attribute name="IsolateStyles" type="TRUEFALSE" default="FALSE" />
    <xs:attribute name="IsRelationship" type="TRUEFALSE" default="FALSE" />
    <xs:attribute name="JoinColName" type="xs:string" default="tp_ID" />
    <xs:attribute name="JoinRowOrdinal" type="xs:int" fixed="0" />
    <xs:attribute name="JoinType" type="JoinType" default="LEFT OUTER" />
    <xs:attribute name="JumpTo" type="xs:string" />
    <xs:attribute name="JumpToFillinChoice" type="xs:string" />
    <xs:attribute name="JumpToNo" type="xs:string" />
    <xs:attribute name="JumpToYes" type="xs:string" />
    <xs:attribute name="LCID" type="xs:int" />
    <xs:attribute name="LinkToItem" type="TRUE_Case_Sensitive_Else_Anything" />
    <xs:attribute name="LinkToItemAllowed type="xs:string" />
    <xs:attribute name="List" type="xs:string" />
    <xs:attribute name="ListItemMenu" type="TRUE_Case_Sensitive_Else_Anything" />
    <xs:attribute name="ListItemMenuAllowed type="xs:string" />
    <xs:attribute name="Max" type="xs:float" />
    <xs:attribute name="MaxLength" type="xs:int" />
    <xs:attribute name="maxLength" type="xs:string" />
    <xs:attribute name="Min" type="xs:string" />
    <xs:attribute name="Mult" type="xs:string" />
    <xs:attribute name="Name" type="xs:string" use="required" />
    <xs:attribute name="NegativeFormat" type="xs:string" />
    <xs:attribute name="node" type="xs:string" />
    <xs:attribute name="Node" type="xs:string" />
    <xs:attribute name="NoEditFormBreak" type="TRUEFALSE" default="FALSE" />
    <xs:attribute name="NumLines" type="xs:string" default="6" />
    <xs:attribute name="Percentage" type="TRUEFALSE" default="FALSE" />
    <xs:attribute name="PIAttribute" type="xs:string" />
    <xs:attribute name="PITarget" type="xs:string" />
    <xs:attribute name="PrependId" type="TRUEFALSE" default="FALSE" />
    <xs:attribute name="Presence" type="TRUEFALSE" default="FALSE" />
    <xs:attribute name="PreviousName" type="xs:string" />
    <xs:attribute name="PrimaryKey" type="TRUEFALSE" />
    <xs:attribute name="PrimaryPIAttribute" type="xs:string" />
    <xs:attribute name="PrimaryPITarget" type="xs:string" />
    <xs:attribute name="ReadOnly" type="TRUEFALSE" default="FALSE" />
    <xs:attribute name="ReadOnlyEnforced" type="TRUEFALSE" default="FALSE" />
    <xs:attribute name="RelationshipDeleteBehavior type="RelationshipDeleteBehaviorAttribute" default="None" />
    <xs:attribute name="RenderXMLUsingPattern" type="TRUEFALSE" default="FALSE" />
    <xs:attribute name="Required" type="TRUEFALSE" default="FALSE" />
    <xs:attribute name="RestrictedMode" type="TRUEFALSE" default="TRUE" />
    <xs:attribute name="ResultType" type="FieldInternalType" />
    <xs:attribute name="ResyncOnChange" type="TRUEFALSE" default="FALSE"/>
    <xs:attribute name="RichText" type="TRUEFALSE" default="FALSE" />
    <xs:attribute name="RichTextMode" type="FieldRichTextMode" default="Compatible" />
    <xs:attribute name="RowOrdinal" type="xs:int" default="0" />
    <xs:attribute name="RowOrdinal2" type="xs:int" default="0" />
    <xs:attribute name="Sealed" type="TRUEFALSE" default="FALSE" />
    <xs:attribute name="SeparateLine" type="TRUEFALSE" default="FALSE" />
    <xs:attribute name="SetAs" type="xs:string" />
    <xs:attribute name="ShowAddressBookButton" type="TRUEFALSE" default="FALSE" />
    <xs:attribute name="ShowField" type="xs:string" />
    <xs:attribute name="ShowInDisplayForm" type="TRUEFALSE" />
    <xs:attribute name="ShowInEditForm" type="TRUEFALSE" default="TRUE" />
    <xs:attribute name="ShowInFileDialog" type="TRUEFALSE" />
    <xs:attribute name="ShowInFileDlg" type="TRUEFALSE" />
    <xs:attribute name="ShowInListSettings" type="TRUEFALSE" />
    <xs:attribute name="ShowInNewForm" type="TRUEFALSE" default="TRUE" />
    <xs:attribute name="ShowInVersionHistory" type="TRUEFALSE" />
    <xs:attribute name="ShowInViewForms" type="TRUEFALSE" />
    <xs:attribute name="Sortable" type="TRUEFALSE" />
    <xs:attribute name="SourceID" type="xs:string" />
    <xs:attribute name="StaticName" type="xs:string" />
    <xs:attribute name="StorageTZ" type="xs:string" />
    <xs:attribute name="StripWS" type="xs:string" />
    <xs:attribute name="SuppressNameDisplay" type="TRUEFALSE" />
    <xs:attribute name="TextOnly" type="TRUEFALSE" />
    <xs:attribute name="Title" type="xs:string" />
    <xs:attribute name="TitleField" type="TRUEFALSE" default="FALSE" />
    <xs:attribute name="Type" type="xs:string" use="required" />
    <xs:attribute name="UniqueId" type="xs:string" />
    <xs:attribute name="UnlimitedLengthInDocumentLibrary" type="TRUEFALSE" />
    <xs:attribute name="URLEncode" type="TRUEFALSE" />
    <xs:attribute name="URLEncodeAsURL" type="TRUEFALSE" />
    <xs:attribute name="UserSelectionMode" type="xs:string" />
    <xs:attribute name="UserSelectionScope" type="xs:int" />
    <xs:attribute name="Version" type="xs:int" default="0" />
    <xs:attribute name="Viewable" type="FALSE_Case_Insensitive_Else_Anything" />
    <xs:attribute name="WebId" type="UniqueIdentifierWithoutBraces" />
    <xs:attribute name="Width" type="xs:int" />
    <xs:attribute name="WikiLinking" type="TRUEFALSE" default="FALSE" />
    <xs:attribute name="WorkflowStatusURL" type="xs:string" use="optional" />
    <xs:attribute name="XName" type="xs:string" />
    <xs:anyAttribute namespace="##other" processContents="lax" />
</xs:complexType>

Share via

FieldCollection.SchemaXml property

Syntax

Property value

Exceptions

Remarks

See also

Reference

Additional resources