This documentation is archived and is not being maintained.

XsdDataContractImporter Class

Allows the transformation of a set of XML schema files (.xsd) into common language runtime (CLR) types.


Namespace:  System.Runtime.Serialization
Assembly:  System.Runtime.Serialization (in System.Runtime.Serialization.dll)

public class XsdDataContractImporter

The XsdDataContractImporter type exposes the following members.

Public methodXsdDataContractImporter()Initializes a new instance of the XsdDataContractImporter class.
Public methodXsdDataContractImporter(CodeCompileUnit)Initializes a new instance of the XsdDataContractImporter class with the CodeCompileUnit that will be used to generate CLR code.

Public propertyCodeCompileUnitGets a CodeCompileUnit used for storing the CLR types generated.
Public propertyOptionsGets or sets an ImportOptions that contains settable options for the import operation.

Public methodCanImport(XmlSchemaSet)Gets a value that indicates whether the schemas contained in an XmlSchemaSet can be transformed into a CodeCompileUnit.
Public methodCanImport(XmlSchemaSet, ICollection<XmlQualifiedName>)Gets a value that indicates whether the specified set of types contained in an XmlSchemaSet can be transformed into CLR types generated into a CodeCompileUnit.
Public methodCanImport(XmlSchemaSet, XmlSchemaElement)Gets a value that indicates whether a specific schema element contained in an XmlSchemaSet can be imported.
Public methodCanImport(XmlSchemaSet, XmlQualifiedName)Gets a value that indicates whether the schemas contained in an XmlSchemaSet can be transformed into a CodeCompileUnit.
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetCodeTypeReference(XmlQualifiedName)Returns a CodeTypeReference to the CLR type generated for the schema type with the specified XmlQualifiedName.
Public methodGetCodeTypeReference(XmlQualifiedName, XmlSchemaElement)Returns a CodeTypeReference for the specified XML qualified element and schema element.
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetKnownTypeReferencesReturns a list of CodeTypeReference objects that represents the known types generated when generating code for the specified schema type.
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodImport(XmlSchemaSet)Transforms the specified set of XML schemas contained in an XmlSchemaSet into a CodeCompileUnit.
Public methodImport(XmlSchemaSet, ICollection<XmlQualifiedName>)Transforms the specified set of schema types contained in an XmlSchemaSet into CLR types generated into a CodeCompileUnit.
Public methodImport(XmlSchemaSet, XmlSchemaElement)Transforms the specified schema element in the set of specified XML schemas into a CodeCompileUnit and returns an XmlQualifiedName that represents the data contract name for the specified element.
Public methodImport(XmlSchemaSet, XmlQualifiedName)Transforms the specified XML schema type contained in an XmlSchemaSet into a CodeCompileUnit.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

Use the XsdDataContractImporter if you are creating a Web service that must interoperate with an existing Web service, or to create data contract types from XML schemas. XsdDataContractImporter will transform a set of XML schemas and create the .NET Framework types that represent the data contract in a selected programming language. To create the code, use the classes in the System.CodeDom namespace.

Conversely, use the XsdDataContractExporter class when you have created a Web service that incorporates data represented by CLR types and when you need to export XML schemas for each data type to be consumed by other Web services. That is, XsdDataContractExporter transforms a set of CLR types into a set of XML schemas.


To generate CLR types from XML schemas at design time, use the Service Model Metadata Utility Tool (Svcutil.exe). To generated code from XSD files, use the /dataContractOnly switch of the tool. You can also use the XsdDataContractImporter if you need more control over the process or need to do it programmatically.

The following example creates an XmlSchemaSet and calls the Import method to create a CodeCompileUnit. The CodeCompileUnit is then used to create both Visual C# and Visual Basic code files.

using System;
using System.CodeDom.Compiler;
using System.CodeDom;
using System.Runtime.Serialization;
using System.IO;
using System.Xml;
using System.Xml.Schema;
using System.Globalization;

namespace XsdContractImporterExample
    class Program
        static void Main(string[] args)
                XmlSchemaSet schemas = Export();
                CodeCompileUnit ccu = Import(schemas);
                CompileCode(ccu, "Person.cs");
                CompileCode(ccu, "Person.vb");
            catch (Exception exc)
                Console.WriteLine("{0}: {1}", exc.Message, exc.StackTrace);
                Console.WriteLine("Press <Enter> to end....");


        static XmlSchemaSet Export()
            XsdDataContractExporter ex = new XsdDataContractExporter();
            return ex.Schemas;
        static CodeCompileUnit Import(XmlSchemaSet schemas)

            XsdDataContractImporter imp = new XsdDataContractImporter();

            // The EnableDataBinding option adds a RaisePropertyChanged method to
            // the generated code. The GenerateInternal causes code access to be
            // set to internal.
            ImportOptions iOptions = new ImportOptions();
            iOptions.EnableDataBinding = true;
            iOptions.GenerateInternal = true;
            imp.Options = iOptions;

            if (imp.CanImport(schemas))
                return imp.CodeCompileUnit;
                return null;
        static void CompileCode(CodeCompileUnit ccu, string sourceName)
            CodeDomProvider provider = null;
            FileInfo sourceFile = new FileInfo(sourceName);
            // Select the code provider based on the input file extension, either C# or Visual Basic.
            if (sourceFile.Extension.ToUpper(CultureInfo.InvariantCulture) == ".CS")
                provider = new Microsoft.CSharp.CSharpCodeProvider();
            else if (sourceFile.Extension.ToUpper(CultureInfo.InvariantCulture) == ".VB")
                provider = new Microsoft.VisualBasic.VBCodeProvider();
                Console.WriteLine("Source file must have a .cs or .vb extension");
            if (provider != null)
                CodeGeneratorOptions options = new CodeGeneratorOptions();
                // Set code formatting options to your preference.
                options.BlankLinesBetweenMembers = true;
                options.BracingStyle = "C";

                StreamWriter sw = new StreamWriter(sourceName);
                provider.GenerateCodeFromCompileUnit(ccu, sw, options);

    public class Person
        public string FirstName;

        public string LastName;

        public Person(string newFName, string newLName)
            FirstName = newFName;
            LastName = newLName;

.NET Framework

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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.