SchemaImporterExtension.ImportSchemaType Method (String, String, XmlSchemaObject, XmlSchemas, XmlSchemaImporter, CodeCompileUnit, CodeNamespace, CodeGenerationOptions, CodeDomProvider)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Allows you to manipulate the code generated by examining the imported schema and specifying the CLR type that it maps to.

Namespace:   System.Xml.Serialization.Advanced
Assembly:  System.Xml (in System.Xml.dll)

public virtual string ImportSchemaType(
	string name,
	string ns,
	XmlSchemaObject context,
	XmlSchemas schemas,
	XmlSchemaImporter importer,
	CodeCompileUnit compileUnit,
	CodeNamespace mainNamespace,
	CodeGenerationOptions options,
	CodeDomProvider codeProvider
)

Parameters

name
Type: System.String

The name of the element.

ns
Type: System.String

The namespace of the element.

context
Type: System.Xml.Schema.XmlSchemaObject

An XmlSchemaObject that represents schema information, such as the line number of the XML element.

schemas
Type: System.Xml.Serialization.XmlSchemas

An XmlSchemas that contains the collection of schemas in the document.

importer
Type: System.Xml.Serialization.XmlSchemaImporter

The XmlSchemaImporter that is the importer being used.

compileUnit
Type: System.CodeDom.CodeCompileUnit

A CodeCompileUnit to which you can add CodeDOM structures to generate alternative code for the XSD.

mainNamespace
Type: System.CodeDom.CodeNamespace

A CodeNamespace that represents the current namespace for the element.

options
Type: System.Xml.Serialization.CodeGenerationOptions

A CodeGenerationOptions for the setting options on the code compiler.

codeProvider
Type: System.CodeDom.Compiler.CodeDomProvider

A CodeDomProvider that is used to generate the new code.

Return Value

Type: System.String

The name of the CLR type that this maps to.

In order to control the generation of the code, you must use the classes found in the System.CodeDom namespace. For more information, see Using the CodeDOM and CodeDOM Quick Reference.

The example below shows a simple implementation of the ImportSchemaType(String, String, XmlSchemaObject, XmlSchemas, XmlSchemaImporter, CodeCompileUnit, CodeNamespace, CodeGenerationOptions, CodeDomProvider) method. The code checks the namespace and name. When the right values are found, it adds the name of a custom assembly ("Order.dll") that must be referenced in the generated code. It then adds a new namespace ("Microsoft.Samples") that is generated in the code.

public override string ImportSchemaType(string name, string ns, 
    XmlSchemaObject context, XmlSchemas schemas, 
    XmlSchemaImporter importer, 
    CodeCompileUnit compileUnit, CodeNamespace codeNamespace, 
    CodeGenerationOptions options, CodeDomProvider codeGenerator)
    {
        if (name.Equals("Order") && ns.Equals("http://orders/"))
        {
            compileUnit.ReferencedAssemblies.Add("Order.dll");
            codeNamespace.Imports.Add
               (new CodeNamespaceImport("Microsoft.Samples"));
             return "Order";
        }
        return null;
    }

.NET Framework
Available since 2.0
Return to top
Show: