XmlSchemaInclude Class

Definition

Namespace:

System.Xml.Schema

Assemblies:

netstandard.dll, System.Xml.ReaderWriter.dll

Source:

XmlSchemaInclude.cs

Represents the include element from XML Schema as specified by the World Wide Web Consortium (W3C). This class is used to include declarations and definitions from an external schema. The included declarations and definitions are then available for processing in the containing schema.

C#

public class XmlSchemaInclude : System.Xml.Schema.XmlSchemaExternal

Inheritance

Object

XmlSchemaObject

XmlSchemaExternal

XmlSchemaInclude

Examples

The following example creates the include element.

C#

using System;
using System.Collections;
using System.IO;
using System.Xml;
using System.Xml.Xsl;
using System.Xml.Schema;

public class ImportIncludeSample
{

    private static void ValidationCallBack(object sender, ValidationEventArgs args)
    {

        if (args.Severity == XmlSeverityType.Warning)
            Console.Write("WARNING: ");
        else if (args.Severity == XmlSeverityType.Error)
            Console.Write("ERROR: ");

        Console.WriteLine(args.Message);
    }

    public static void Main()
    {

        XmlSchema schema = new XmlSchema();
        schema.ElementFormDefault = XmlSchemaForm.Qualified;
        schema.TargetNamespace = "http://www.w3.org/2001/05/XMLInfoset";

        // <xs:import namespace="http://www.example.com/IPO" />
        XmlSchemaImport import = new XmlSchemaImport();
        import.Namespace = "http://www.example.com/IPO";
        schema.Includes.Add(import);

        // <xs:include schemaLocation="example.xsd" />
        XmlSchemaInclude include = new XmlSchemaInclude();
        include.SchemaLocation = "example.xsd";
        schema.Includes.Add(include);

        XmlSchemaSet schemaSet = new XmlSchemaSet();
        schemaSet.ValidationEventHandler += new ValidationEventHandler(ValidationCallBack);
        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);
    }/* Main() */
} //ImportIncludeSample

The following XML is generated for this code example.

XML

<?xml version="1.0" encoding="IBM437"?>
<schema elementFormDefault="qualified" targetNamespace="http://www.w3.org/2001/05/XMLInfoset" xmlns="http://www.w3.org/2001/XMLSchema">
  <import namespace="http://www.example.com/IPO" />
  <include schemaLocation="example.xsd" />
</schema>

Remarks

The included schema document must meet one of the following conditions:

The included schema must have the same target namespace as the containing schema document.

OR

The included schema cannot have a specified targetNamespace; the targetNamespace attribute must be null.

XmlSchemaInclude adds all the schema components from included schemas that have the same target namespace (or no specified target namespace) to the containing schema.

Constructors

XmlSchemaInclude()

Initializes a new instance of the XmlSchemaInclude class.

Properties

Annotation	Gets or sets the annotation property.
Id	Gets or sets the string id. (Inherited from XmlSchemaExternal)
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)
Parent	Gets or sets the parent of this XmlSchemaObject. (Inherited from XmlSchemaObject)
Schema	Gets or sets the XmlSchema for the referenced schema. (Inherited from XmlSchemaExternal)
SchemaLocation	Gets or sets the Uniform Resource Identifier (URI) location for the schema, which tells the schema processor where the schema physically resides. (Inherited from XmlSchemaExternal)
SourceUri	Gets or sets the source location for the file that loaded the schema. (Inherited from XmlSchemaObject)
UnhandledAttributes	Gets or sets the qualified attributes, which do not belong to the schema target namespace. (Inherited from XmlSchemaExternal)

Methods

Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (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)
ToString()	Returns a string that represents the current object. (Inherited from Object)

Applies to