Export (0) Print
Expand All

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)

public class XmlSchema : XmlSchemaObject

The XmlSchema type exposes the following members.

  NameDescription
Public methodSupported by the XNA FrameworkXmlSchemaInitializes a new instance of the XmlSchema class.
Top

  NameDescription
Public propertySupported by the XNA FrameworkAttributeFormDefaultGets or sets the form for attributes declared in the target namespace of the schema.
Public propertySupported by the XNA FrameworkAttributeGroupsGets the post-schema-compilation value of all the global attribute groups in the schema.
Public propertySupported by the XNA FrameworkAttributesGets the post-schema-compilation value for all the attributes in the schema.
Public propertySupported by the XNA FrameworkBlockDefaultGets 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.
Public propertySupported by the XNA FrameworkElementFormDefaultGets or sets the form for elements declared in the target namespace of the schema.
Public propertySupported by the XNA FrameworkElementsGets the post-schema-compilation value for all the elements in the schema.
Public propertySupported by the XNA FrameworkFinalDefaultGets 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.
Public propertySupported by the XNA FrameworkGroupsGets the post-schema-compilation value of all the groups in the schema.
Public propertySupported by the XNA FrameworkIdGets or sets the string ID.
Public propertySupported by the XNA FrameworkIncludesGets the collection of included and imported schemas.
Public propertySupported by the XNA FrameworkIsCompiledIndicates if the schema has been compiled.
Public propertySupported by the XNA FrameworkItemsGets the collection of schema elements in the schema and is used to add new element types at the schema element level.
Public propertySupported by the XNA FrameworkLineNumberGets or sets the line number in the file to which the schema element refers. (Inherited from XmlSchemaObject.)
Public propertySupported by the XNA FrameworkLinePositionGets or sets the line position in the file to which the schema element refers. (Inherited from XmlSchemaObject.)
Public propertySupported by the XNA FrameworkNamespacesGets or sets the XmlSerializerNamespaces to use with this schema object. (Inherited from XmlSchemaObject.)
Public propertySupported by the XNA FrameworkNotationsGets the post-schema-compilation value for all notations in the schema.
Public propertySupported by the XNA FrameworkParentGets or sets the parent of this XmlSchemaObject. (Inherited from XmlSchemaObject.)
Public propertySupported by the XNA FrameworkSchemaTypesGets the post-schema-compilation value of all schema types in the schema.
Public propertySupported by the XNA FrameworkSourceUriGets or sets the source location for the file that loaded the schema. (Inherited from XmlSchemaObject.)
Public propertySupported by the XNA FrameworkTargetNamespaceGets or sets the Uniform Resource Identifier (URI) of the schema target namespace.
Public propertySupported by the XNA FrameworkUnhandledAttributesGets and sets the qualified attributes which do not belong to the schema target namespace.
Public propertySupported by the XNA FrameworkVersionGets or sets the version of the schema.
Top

  NameDescription
Public methodCompile(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.
Public methodCompile(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.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodStatic memberSupported by the XNA FrameworkRead(Stream, ValidationEventHandler)Reads an XML Schema from the supplied stream.
Public methodStatic memberSupported by the XNA FrameworkRead(TextReader, ValidationEventHandler)Reads an XML Schema from the supplied TextReader.
Public methodStatic memberSupported by the XNA FrameworkRead(XmlReader, ValidationEventHandler)Reads an XML Schema from the supplied XmlReader.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodSupported by the XNA FrameworkWrite(Stream)Writes the XML Schema to the supplied data stream.
Public methodSupported by the XNA FrameworkWrite(TextWriter)Writes the XML Schema to the supplied TextWriter.
Public methodSupported by the XNA FrameworkWrite(XmlWriter)Writes the XML Schema to the supplied XmlWriter.
Public methodSupported by the XNA FrameworkWrite(Stream, XmlNamespaceManager)Writes the XML Schema to the supplied Stream using the XmlNamespaceManager specified.
Public methodSupported by the XNA FrameworkWrite(TextWriter, XmlNamespaceManager)Writes the XML Schema to the supplied TextWriter.
Public methodSupported by the XNA FrameworkWrite(XmlWriter, XmlNamespaceManager)Writes the XML Schema to the supplied XmlWriter.
Top

  NameDescription
Public fieldStatic memberSupported by the XNA FrameworkInstanceNamespaceThe XML schema instance namespace. This field is constant.
Public fieldStatic memberSupported by the XNA FrameworkNamespaceThe XML schema namespace. This field is constant.
Top

Security noteSecurity 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>

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone 8, Silverlight 8.1

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

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