XsdDataContractImporter Klasse

Definition

Ermöglicht die Transformation einer Reihe von XML-Schemadateien (.xsd) in Common Language Runtime (CLR)-Typen.Allows the transformation of a set of XML schema files (.xsd) into common language runtime (CLR) types.

public ref class XsdDataContractImporter
public class XsdDataContractImporter
type XsdDataContractImporter = class
Public Class XsdDataContractImporter
Vererbung
XsdDataContractImporter

Beispiele

Im folgenden Beispiel wird ein XmlSchemaSet erstellt und die Import-Methode aufgerufen, um einen CodeCompileUnit zu erstellen.The following example creates an XmlSchemaSet and calls the Import method to create a CodeCompileUnit. Der CodeCompileUnit wird dann verwendet, um sowohl Visual C#- als auch Visual Basic-Codedateien zu erstellen.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)
        {
            try
            {
                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);
            }
            finally
            {
                Console.WriteLine("Press <Enter> to end....");
                Console.ReadLine();
            }

        }

        static XmlSchemaSet Export()
        {
            XsdDataContractExporter ex = new XsdDataContractExporter();
            ex.Export(typeof(Person));
            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))
            {
                imp.Import(schemas);
                return imp.CodeCompileUnit;
            }
            else
                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();
            }
            else
            {
                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);
                sw.Close();
            }
        }
    }

    [DataContract]
    public class Person
    {
        [DataMember]
        public string FirstName;

        [DataMember]
        public string LastName;

        public Person(string newFName, string newLName)
        {
            FirstName = newFName;
            LastName = newLName;
        }
    }
}
Imports System.CodeDom.Compiler
Imports System.CodeDom
Imports System.Runtime.Serialization
Imports System.IO
Imports System.Xml
Imports System.Xml.Schema
Imports System.Globalization

Class Program
   
    Shared Sub Main(ByVal args() As String) 
        Try
            Dim schemas As XmlSchemaSet = Export()
            Dim ccu As CodeCompileUnit = Import(schemas)
            CompileCode(ccu, "Person.cs")
            CompileCode(ccu, "Person.vb")
        Catch exc As Exception
            Console.WriteLine("{0}: {1}", exc.Message, exc.StackTrace)
        Finally
            Console.WriteLine("Press <Enter> to end....")
            Console.ReadLine()
        End Try
    
    End Sub 
    
    Shared Function Export() As XmlSchemaSet 
        Dim ex As New XsdDataContractExporter()
        ex.Export(GetType(Person))
        Return ex.Schemas
    End Function
    Shared Function Import(ByVal schemas As XmlSchemaSet) As CodeCompileUnit 

        Dim imp As New XsdDataContractImporter()
       ' The EnableDataBinding option adds a RaisePropertyChanged method to
       ' the generated code. The GenerateInternal causes code access to be
       ' set to internal.
       Dim iOptions As New ImportOptions()
       iOptions.EnableDataBinding = true
       iOptions.GenerateInternal = true
       imp.Options = IOptions

        If imp.CanImport(schemas) Then
            imp.Import(schemas)
            Return imp.CodeCompileUnit
        Else
            Return Nothing
        End If
    End Function

    Shared Sub CompileCode(ByVal ccu As CodeCompileUnit, ByVal sourceName As String) 
        Dim provider As CodeDomProvider = Nothing
        Dim sourceFile As 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" Then
            provider = New Microsoft.CSharp.CSharpCodeProvider()
        ElseIf sourceFile.Extension.ToUpper(CultureInfo.InvariantCulture) = ".VB" Then
            provider = New Microsoft.VisualBasic.VBCodeProvider()
        Else
            Console.WriteLine("Source file must have a .cs or .vb extension")
        End If
        If Not (provider Is Nothing) Then
            Dim options As New CodeGeneratorOptions()
            ' Set code formatting options to your preference. 
            options.BlankLinesBetweenMembers = True
            options.BracingStyle = "C"
            
            Dim sw As New StreamWriter(sourceName)
            provider.GenerateCodeFromCompileUnit(ccu, sw, options)
            sw.Close()
        End If
    
    End Sub
End Class

<DataContract()>  _
Public Class Person
    <DataMember()>  _
    Public FirstName As String
    
    <DataMember()>  _
    Public LastName As String
    
    
    Public Sub New(ByVal newFName As String, ByVal newLName As String) 
        FirstName = newFName
        LastName = newLName
    
    End Sub 
End Class 

Hinweise

Verwenden Sie den XsdDataContractImporter, wenn Sie einen Webdienst erstellen, der mit einem bestehenden Webdienst zusammenarbeiten muss, oder um Datenvertragstypen aus XML-Schemas zu erstellen.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 transformiert eine Gruppe von XML-Schemas und erstellt die .NET Framework.NET Framework-Typen, die den Datenvertrag in einer ausgewählten Programmiersprache darstellen.XsdDataContractImporter will transform a set of XML schemas and create the .NET Framework.NET Framework types that represent the data contract in a selected programming language. Um den Code zu erstellen, verwenden Sie die Klassen im System.CodeDom-Namespace.To create the code, use the classes in the System.CodeDom namespace.

Umgekehrt können Sie die XsdDataContractExporter-Klasse verwenden, wenn Sie einen Webdienst erstellt haben, der Daten enthält, die als CLR-Typen dargestellt werden, und wenn Sie für die von anderen Webdiensten zu verwendenden Datentypen XML-Schemas exportieren wollen.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. Dies bedeutet, dass XsdDataContractExporter einen Satz von CLR-Typen in einen Satz von XML-Schemas transformiert.That is, XsdDataContractExporter transforms a set of CLR types into a set of XML schemas.

Hinweis

Um CLR-Typen aus XML-Schemas zur Entwurfszeit zu generieren, verwenden Sie das Service Model Metadata Utility-Tool (Svcutil. exe).To generate CLR types from XML schemas at design time, use the ServiceModel Metadata Utility Tool (Svcutil.exe). Um Code aus XSD-Dateien zu generieren, /dataContractOnly verwenden Sie den-Schalter des Tools.To generated code from XSD files, use the /dataContractOnly switch of the tool. Sie können auch den XsdDataContractImporter verwenden, wenn Sie mehr Kontrolle über den Vorgang benötigen oder wenn dieser programmgesteuert sein muss.You can also use the XsdDataContractImporter if you need more control over the process or need to do it programmatically.

Konstruktoren

XsdDataContractImporter()

Initialisiert eine neue Instanz der XsdDataContractImporter-Klasse.Initializes a new instance of the XsdDataContractImporter class.

XsdDataContractImporter(CodeCompileUnit)

Initialisiert eine neue Instanz der XsdDataContractImporter-Klasse mit dem CodeCompileUnit, der zur Generierung von CLR-Code verwendet wird.Initializes a new instance of the XsdDataContractImporter class with the CodeCompileUnit that will be used to generate CLR code.

Eigenschaften

CodeCompileUnit

Ruft einen CodeCompileUnit auf, der zum Speichern der generierten CLR-Typen verwendet wird.Gets a CodeCompileUnit used for storing the CLR types generated.

Options

Ruft einen ImportOptions auf, der festlegbare Optionen für den Importvorgang enthält, oder legt diesen fest.Gets or sets an ImportOptions that contains settable options for the import operation.

Methoden

CanImport(XmlSchemaSet)

Ruft einen Wert ab, der angibt, ob die in einem XmlSchemaSet enthaltenen Schemas in einen CodeCompileUnit transformiert werden können.Gets a value that indicates whether the schemas contained in an XmlSchemaSet can be transformed into a CodeCompileUnit.

CanImport(XmlSchemaSet, ICollection<XmlQualifiedName>)

Ruft einen Wert ab, der anzeigt, ob der in einem XmlSchemaSet enthaltene angegebene Typensatz in CLR-Typen transformiert werden kann, die in einen CodeCompileUnit generiert werden.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.

CanImport(XmlSchemaSet, XmlQualifiedName)

Ruft einen Wert ab, der angibt, ob die in einem XmlSchemaSet enthaltenen Schemas in einen CodeCompileUnit transformiert werden können.Gets a value that indicates whether the schemas contained in an XmlSchemaSet can be transformed into a CodeCompileUnit.

CanImport(XmlSchemaSet, XmlSchemaElement)

Ruft einen Wert ab, der angibt, ob ein bestimmtes in einem XmlSchemaSet enthaltenes Schemaelement importiert werden kann.Gets a value that indicates whether a specific schema element contained in an XmlSchemaSet can be imported.

Equals(Object)

Ermittelt, ob das angegebene Objekt und das aktuelle Objekt gleich sind.Determines whether the specified object is equal to the current object.

(Geerbt von Object)
GetCodeTypeReference(XmlQualifiedName)

Gibt einen CodeTypeReference an den CLR-Typ zurück, der für den Schematyp mit dem angegebenen XmlQualifiedName generiert wurde.Returns a CodeTypeReference to the CLR type generated for the schema type with the specified XmlQualifiedName.

GetCodeTypeReference(XmlQualifiedName, XmlSchemaElement)

Gibt einen CodeTypeReference für das angegebene qualifizierte XML-Element und Schemaelement zurück.Returns a CodeTypeReference for the specified XML qualified element and schema element.

GetHashCode()

Dient als die Standard-HashfunktionServes as the default hash function.

(Geerbt von Object)
GetKnownTypeReferences(XmlQualifiedName)

Gibt eine Liste von CodeTypeReference-Objekten zurück, die die bekannten Typen darstellt, die bei der Generierung von Code für den angegebenen Schematyp erstellt wurden.Returns a list of CodeTypeReference objects that represents the known types generated when generating code for the specified schema type.

GetType()

Ruft den Type der aktuellen Instanz ab.Gets the Type of the current instance.

(Geerbt von Object)
Import(XmlSchemaSet)

Transformiert den angegebenen Satz von XML-Schemas, die in einem XmlSchemaSet enthalten sind, in einen CodeCompileUnit.Transforms the specified set of XML schemas contained in an XmlSchemaSet into a CodeCompileUnit.

Import(XmlSchemaSet, ICollection<XmlQualifiedName>)

Transformiert den angegebenen Satz von Schematypen, der in einem XmlSchemaSet enthalten ist, in CLR-Typen, die in einen CodeCompileUnit generiert werden.Transforms the specified set of schema types contained in an XmlSchemaSet into CLR types generated into a CodeCompileUnit.

Import(XmlSchemaSet, XmlQualifiedName)

Transformiert den angegebenen, in einem XmlSchemaSet enthaltenen XML-Schematyp in einen CodeCompileUnit.Transforms the specified XML schema type contained in an XmlSchemaSet into a CodeCompileUnit.

Import(XmlSchemaSet, XmlSchemaElement)

Transformiert das angegebene Schemaelement in dem Satz angegebener XML-Schemas in einen CodeCompileUnit und gibt einen XmlQualifiedName zurück, der den Datenvertragsnamen für das angegebene Element darstellt.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.

MemberwiseClone()

Erstellt eine flache Kopie des aktuellen Object.Creates a shallow copy of the current Object.

(Geerbt von Object)
ToString()

Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt.Returns a string that represents the current object.

(Geerbt von Object)

Gilt für:

Siehe auch