XmlSchema Class

 

An in-memory representation of an XML Schema, as specified in the World Wide Web Consortium (W3C) XML Schema Part 1: Structures and XML Schema Part 2: Datatypes specifications.

Namespace:   System.Xml.Schema
Assembly:  System.Xml (in System.Xml.dll)

System.Object
  System.Xml.Schema.XmlSchemaObject
    System.Xml.Schema.XmlSchema

public class XmlSchema : XmlSchemaObject

NameDescription
System_CAPS_pubmethodXmlSchema()

Initializes a new instance of the XmlSchema class.

NameDescription
System_CAPS_pubpropertyAttributeFormDefault

Gets or sets the form for attributes declared in the target namespace of the schema.

System_CAPS_pubpropertyAttributeGroups

Gets the post-schema-compilation value of all the global attribute groups in the schema.

System_CAPS_pubpropertyAttributes

Gets the post-schema-compilation value for all the attributes in the schema.

System_CAPS_pubpropertyBlockDefault

Gets or sets the blockDefault attribute which sets the default value of the block attribute on element and complex types in the targetNamespace of the schema.

System_CAPS_pubpropertyElementFormDefault

Gets or sets the form for elements declared in the target namespace of the schema.

System_CAPS_pubpropertyElements

Gets the post-schema-compilation value for all the elements in the schema.

System_CAPS_pubpropertyFinalDefault

Gets or sets the finalDefault attribute which sets the default value of the final attribute on elements and complex types in the target namespace of the schema.

System_CAPS_pubpropertyGroups

Gets the post-schema-compilation value of all the groups in the schema.

System_CAPS_pubpropertyId

Gets or sets the string ID.

System_CAPS_pubpropertyIncludes

Gets the collection of included and imported schemas.

System_CAPS_pubpropertyIsCompiled

Indicates if the schema has been compiled.

System_CAPS_pubpropertyItems

Gets the collection of schema elements in the schema and is used to add new element types at the schema element level.

System_CAPS_pubpropertyLineNumber

Gets or sets the line number in the file to which the schema element refers.(Inherited from XmlSchemaObject.)

System_CAPS_pubpropertyLinePosition

Gets or sets the line position in the file to which the schema element refers.(Inherited from XmlSchemaObject.)

System_CAPS_pubpropertyNamespaces

Gets or sets the XmlSerializerNamespaces to use with this schema object.(Inherited from XmlSchemaObject.)

System_CAPS_pubpropertyNotations

Gets the post-schema-compilation value for all notations in the schema.

System_CAPS_pubpropertyParent

Gets or sets the parent of this XmlSchemaObject.(Inherited from XmlSchemaObject.)

System_CAPS_pubpropertySchemaTypes

Gets the post-schema-compilation value of all schema types in the schema.

System_CAPS_pubpropertySourceUri

Gets or sets the source location for the file that loaded the schema.(Inherited from XmlSchemaObject.)

System_CAPS_pubpropertyTargetNamespace

Gets or sets the Uniform Resource Identifier (URI) of the schema target namespace.

System_CAPS_pubpropertyUnhandledAttributes

Gets and sets the qualified attributes which do not belong to the schema target namespace.

System_CAPS_pubpropertyVersion

Gets or sets the version of the schema.

NameDescription
System_CAPS_pubmethodCompile(ValidationEventHandler)

Obsolete.Compiles the XML Schema Object Model (SOM) into schema information for validation. Used to check the syntactic and semantic structure of the programmatically built SOM. Semantic validation checking is performed during compilation.

System_CAPS_pubmethodCompile(ValidationEventHandler, XmlResolver)

Obsolete.Compiles the XML Schema Object Model (SOM) into schema information for validation. Used to check the syntactic and semantic structure of the programmatically built SOM. Semantic validation checking is performed during compilation.

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodSystem_CAPS_staticRead(Stream, ValidationEventHandler)

Reads an XML Schema from the supplied stream.

System_CAPS_pubmethodSystem_CAPS_staticRead(TextReader, ValidationEventHandler)

Reads an XML Schema from the supplied TextReader.

System_CAPS_pubmethodSystem_CAPS_staticRead(XmlReader, ValidationEventHandler)

Reads an XML Schema from the supplied XmlReader.

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

System_CAPS_pubmethodWrite(Stream)

Writes the XML Schema to the supplied data stream.

System_CAPS_pubmethodWrite(Stream, XmlNamespaceManager)

Writes the XML Schema to the supplied Stream using the XmlNamespaceManager specified.

System_CAPS_pubmethodWrite(TextWriter)

Writes the XML Schema to the supplied TextWriter.

System_CAPS_pubmethodWrite(TextWriter, XmlNamespaceManager)

Writes the XML Schema to the supplied TextWriter.

System_CAPS_pubmethodWrite(XmlWriter)

Writes the XML Schema to the supplied XmlWriter.

System_CAPS_pubmethodWrite(XmlWriter, XmlNamespaceManager)

Writes the XML Schema to the supplied XmlWriter.

NameDescription
System_CAPS_pubfieldSystem_CAPS_staticInstanceNamespace

The XML schema instance namespace. This field is constant.

System_CAPS_pubfieldSystem_CAPS_staticNamespace

The XML schema namespace. This field is constant.

System_CAPS_security Security Note
  • Do not use schemas from unknown or untrusted sources or locations. Doing so will compromise the security of your code.

  • XML schemas (including inline schemas) are inherently vulnerable to denial of service attacks; do not accept them in untrusted scenarios.

  • Exceptions raised as a result of using the XmlSchema class, such as the XmlSchemaException class, may contain sensitive information that should not be exposed in untrusted scenarios. For example, the SourceUri property of an XmlSchemaException returns the URI path to the schema file that caused the exception. The SourceUri property should not be exposed in untrusted scenarios. Exceptions should be properly handled so this sensitive information is not exposed in untrusted scenarios.

The following example creates a schema definition.

using System;
using System.Xml;
using System.Xml.Schema;

class XMLSchemaExamples
{
    public static void Main()
    {

        XmlSchema schema = new XmlSchema();

        // <xs:element name="cat" type="xs:string"/>
        XmlSchemaElement elementCat = new XmlSchemaElement();
        schema.Items.Add(elementCat);
        elementCat.Name = "cat";
        elementCat.SchemaTypeName = new XmlQualifiedName("string", "http://www.w3.org/2001/XMLSchema");

        // <xs:element name="dog" type="xs:string"/>
        XmlSchemaElement elementDog = new XmlSchemaElement();
        schema.Items.Add(elementDog);
        elementDog.Name = "dog";
        elementDog.SchemaTypeName = new XmlQualifiedName("string", "http://www.w3.org/2001/XMLSchema");

        // <xs:element name="redDog" substitutionGroup="dog" />
        XmlSchemaElement elementRedDog = new XmlSchemaElement();
        schema.Items.Add(elementRedDog);
        elementRedDog.Name = "redDog";
        elementRedDog.SubstitutionGroup = new XmlQualifiedName("dog");

        // <xs:element name="brownDog" substitutionGroup ="dog" />
        XmlSchemaElement elementBrownDog = new XmlSchemaElement();
        schema.Items.Add(elementBrownDog);
        elementBrownDog.Name = "brownDog";
        elementBrownDog.SubstitutionGroup = new XmlQualifiedName("dog");


        // <xs:element name="pets">
        XmlSchemaElement elementPets = new XmlSchemaElement();
        schema.Items.Add(elementPets);
        elementPets.Name = "pets";

        // <xs:complexType>
        XmlSchemaComplexType complexType = new XmlSchemaComplexType();
        elementPets.SchemaType = complexType;

        // <xs:choice minOccurs="0" maxOccurs="unbounded">
        XmlSchemaChoice choice = new XmlSchemaChoice();
        complexType.Particle = choice;
        choice.MinOccurs = 0;
        choice.MaxOccursString = "unbounded";

        // <xs:element ref="cat"/>
        XmlSchemaElement catRef = new XmlSchemaElement();
        choice.Items.Add(catRef);
        catRef.RefName = new XmlQualifiedName("cat");

        // <xs:element ref="dog"/>
        XmlSchemaElement dogRef = new XmlSchemaElement();
        choice.Items.Add(dogRef);
        dogRef.RefName = new XmlQualifiedName("dog");

        XmlSchemaSet schemaSet = new XmlSchemaSet();
        schemaSet.ValidationEventHandler += new ValidationEventHandler(ValidationCallbackOne);
        schemaSet.Add(schema);
        schemaSet.Compile();

        XmlSchema compiledSchema = null;

        foreach (XmlSchema schema1 in schemaSet.Schemas())
        {
            compiledSchema = schema1;
        }

        XmlNamespaceManager nsmgr = new XmlNamespaceManager(new NameTable());
        nsmgr.AddNamespace("xs", "http://www.w3.org/2001/XMLSchema");
        compiledSchema.Write(Console.Out, nsmgr);
    }

    public static void ValidationCallbackOne(object sender, ValidationEventArgs args)
    {
        Console.WriteLine(args.Message);
    }
}

The following XML file is generated for the preceding code example.


<?xml version="1.0" encoding="IBM437"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:element name="cat" type="xs:string"/>
    <xs:element name="dog" type="xs:string"/>
    <xs:element name="redDog" type="xs:string" substitutionGroup="dog"/>
    <xs:element name="brownDog" type="xs:string" substitutionGroup ="dog" />

    <xs:element name="pets">
      <xs:complexType>
        <xs:choice minOccurs="0" maxOccurs="unbounded">
          <xs:element ref="cat"/>
          <xs:element ref="dog"/>
        </xs:choice>
      </xs:complexType>
    </xs:element>
</xs:schema>

Universal Windows Platform
Available since 8
.NET Framework
Available since 1.1
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: