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)
The XmlSchema type exposes the following members.
| Name | Description | |
|---|---|---|
![]() ![]() | AttributeFormDefault | Gets or sets the form for attributes declared in the target namespace of the schema. |
![]() ![]() | AttributeGroups | Gets the post-schema-compilation value of all the global attribute groups in the schema. |
![]() ![]() | Attributes | Gets the post-schema-compilation value for all the attributes in the schema. |
![]() ![]() | BlockDefault | 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. |
![]() ![]() | ElementFormDefault | Gets or sets the form for elements declared in the target namespace of the schema. |
![]() ![]() | Elements | Gets the post-schema-compilation value for all the elements in the schema. |
![]() ![]() | FinalDefault | 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. |
![]() ![]() | Groups | Gets the post-schema-compilation value of all the groups in the schema. |
![]() ![]() | Id | Gets or sets the string ID. |
![]() ![]() | Includes | Gets the collection of included and imported schemas. |
![]() ![]() | IsCompiled | Indicates if the schema has been compiled. |
![]() ![]() | Items | Gets the collection of schema elements in the schema and is used to add new element types at the schema element level. |
![]() ![]() | LineNumber | Gets or sets the line number in the file to which the schema element refers. (Inherited from XmlSchemaObject.) |
![]() ![]() | LinePosition | Gets or sets the line position in the file to which the schema element refers. (Inherited from XmlSchemaObject.) |
![]() ![]() | Namespaces | Gets or sets the XmlSerializerNamespaces to use with this schema object. (Inherited from XmlSchemaObject.) |
![]() ![]() | Notations | Gets the post-schema-compilation value for all notations in the schema. |
![]() ![]() | Parent | Gets or sets the parent of this XmlSchemaObject. (Inherited from XmlSchemaObject.) |
![]() ![]() | SchemaTypes | Gets the post-schema-compilation value of all schema types in the schema. |
![]() ![]() | SourceUri | Gets or sets the source location for the file that loaded the schema. (Inherited from XmlSchemaObject.) |
![]() ![]() | TargetNamespace | Gets or sets the Uniform Resource Identifier (URI) of the schema target namespace. |
![]() ![]() | UnhandledAttributes | Gets and sets the qualified attributes which do not belong to the schema target namespace. |
![]() ![]() | Version | Gets or sets the version of the schema. |
| Name | Description | |
|---|---|---|
![]() | Compile(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. |
![]() | Compile(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. |
![]() ![]() ![]() ![]() | Equals(Object) | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
![]() ![]() ![]() ![]() | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
![]() ![]() ![]() ![]() | GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
![]() ![]() ![]() ![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() ![]() ![]() ![]() | MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
![]() ![]() ![]() | Read(Stream, ValidationEventHandler) | Reads an XML Schema from the supplied stream. |
![]() ![]() ![]() | Read(TextReader, ValidationEventHandler) | Reads an XML Schema from the supplied TextReader. |
![]() ![]() ![]() | Read(XmlReader, ValidationEventHandler) | Reads an XML Schema from the supplied XmlReader. |
![]() ![]() ![]() ![]() | ToString | Returns a string that represents the current object. (Inherited from Object.) |
![]() ![]() | Write(Stream) | Writes the XML Schema to the supplied data stream. |
![]() ![]() | Write(TextWriter) | Writes the XML Schema to the supplied TextWriter. |
![]() ![]() | Write(XmlWriter) | Writes the XML Schema to the supplied XmlWriter. |
![]() ![]() | Write(Stream, XmlNamespaceManager) | Writes the XML Schema to the supplied Stream using the XmlNamespaceManager specified. |
![]() ![]() | Write(TextWriter, XmlNamespaceManager) | Writes the XML Schema to the supplied TextWriter. |
![]() ![]() | Write(XmlWriter, XmlNamespaceManager) | Writes the XML Schema to the supplied XmlWriter. |
| Name | Description | |
|---|---|---|
![]() ![]() ![]() | InstanceNamespace | The XML schema instance namespace. This field is constant. |
![]() ![]() ![]() | Namespace | The XML schema namespace. This field is constant. |
Security Note |
|---|
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 that 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>
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.








Security Note