XsdDataContractExporter XsdDataContractExporter XsdDataContractExporter XsdDataContractExporter Class

Definition

Ermöglicht die Transformation einer in Datenverträgen verwendeten Gruppe von .NET Framework-Typen in eine XML-Schemadatei (XSD).Allows the transformation of a set of .NET Framework types that are used in data contracts into an XML schema file (.xsd).

public ref class XsdDataContractExporter
public class XsdDataContractExporter
type XsdDataContractExporter = class
Public Class XsdDataContractExporter
Vererbung
XsdDataContractExporterXsdDataContractExporterXsdDataContractExporterXsdDataContractExporter

Beispiele

Im folgenden Beispiel wird eine Instanz von XsdDataContractExporter erstellt, und die Export(Type)-Methode wird aufgerufen.The following example creates an instance of the XsdDataContractExporter and calls the Export(Type) method.

using System;
using System.Xml;
using System.Runtime.Serialization;
using System.Xml.Schema;

public class Program
{
    public static void Main()
    {
        try
        {
            ExportXSD();
        }
        catch (Exception exc)
        {
            Console.WriteLine("Message: {0} StackTrace:{1}", exc.Message, exc.StackTrace);
        }
        finally
        {
            Console.ReadLine();
        }
    }

    static void ExportXSD()
    {
        XsdDataContractExporter exporter = new XsdDataContractExporter();
        if (exporter.CanExport(typeof(Employee)))
        {
            exporter.Export(typeof(Employee));
            Console.WriteLine("number of schemas: {0}", exporter.Schemas.Count);
            Console.WriteLine();
            XmlSchemaSet mySchemas = exporter.Schemas;

            XmlQualifiedName XmlNameValue = exporter.GetRootElementName(typeof(Employee));
            string EmployeeNameSpace = XmlNameValue.Namespace;

            foreach (XmlSchema schema in mySchemas.Schemas(EmployeeNameSpace))
            {
                schema.Write(Console.Out);
            }
        }
    }

    static void GetXmlElementName()
    {
        XsdDataContractExporter myExporter = new XsdDataContractExporter();
        XmlQualifiedName xmlElementName =myExporter.GetRootElementName(typeof(Employee));
        Console.WriteLine("Namespace: {0}", xmlElementName.Namespace);
        Console.WriteLine("Name: {0}", xmlElementName.Name);
        Console.WriteLine("IsEmpty: {0}", xmlElementName.IsEmpty);
    }

    [DataContract(Namespace = "www.Contoso.com/Examples/")]
    public class Employee
    {
        [DataMember]
        public string EmployeeName;
        [DataMember]
        private string ID;
    }
}
Imports System.Collections
Imports System.Xml
Imports System.Runtime.Serialization
Imports System.Xml.Schema

Public Class Program
    Public Shared Sub Main() 
        Try
            ExportXSD()
        Catch exc As Exception
            Console.WriteLine("Message: {0} StackTrace:{1}", exc.Message, exc.StackTrace)
        Finally
            Console.ReadLine()
        End Try
    
    End Sub 
    
    
    Shared Sub ExportXSD() 

        Dim exporter As New XsdDataContractExporter()

        ' Use the ExportOptions to add the Possessions type to the 
        ' collection of KnownTypes. 
        Dim eOptions As New ExportOptions()
        eOptions.KnownTypes.Add(GetType(Possessions))        
        exporter.Options = eOptions

        If exporter.CanExport(GetType(Employee)) Then
            exporter.Export(GetType(Employee))
            Console.WriteLine("number of schemas: {0}", exporter.Schemas.Count)
            Console.WriteLine()
            Dim mySchemas As XmlSchemaSet = exporter.Schemas
            
            Dim XmlNameValue As XmlQualifiedName = _
               exporter.GetRootElementName(GetType(Employee))
            Dim EmployeeNameSpace As String = XmlNameValue.Namespace
            
            Dim schema As XmlSchema
            For Each schema In  mySchemas.Schemas(EmployeeNameSpace)
                schema.Write(Console.Out)
            Next schema
        End If
    
    End Sub 
    
    
    Shared Sub GetXmlElementName() 
        Dim myExporter As New XsdDataContractExporter()
        Dim xmlElementName As XmlQualifiedName = myExporter. _
            GetRootElementName(GetType(Employee))
        Console.WriteLine("Namespace: {0}", xmlElementName.Namespace)
        Console.WriteLine("Name: {0}", xmlElementName.Name)
        Console.WriteLine("IsEmpty: {0}", xmlElementName.IsEmpty)
    
    End Sub 
    
    <DataContract([Namespace] := "www.Contoso.com/Examples/")>  _
    Public Class Employee

        <DataMember()>  _
        Public EmployeeName As String
        <DataMember()>  _
        Private ID As String
        ' This member may return a Possessions type.
        <DataMember> _
        public Miscellaneous As Hashtable 

    End Class 

    <DataContract> _
    Public Class Possessions

        <DataMember> _
        Public ItemName As String
    End Class

End Class

Hinweise

Verwenden Sie die XsdDataContractExporter-Klasse, wenn Sie einen Webdienst erstellt haben, der Daten enthält, die als Common Language Runtime (CLR)-Typen dargestellt werden, und wenn Sie für die von anderen Webdiensten zu verwendenden Typen XML-Schemas exportieren wollen,Use the XsdDataContractExporter class when you have created a Web service that incorporates data represented by common language runtime (CLR) types and when you need to export XML schemas for each type to be consumed by other Web services. d. h. XsdDataContractExporter transformiert einen Satz von CLR-Typen in XML-Schemas.That is, XsdDataContractExporter transforms a set of CLR types into XML schemas. (Weitere Informationen zu den Typen, die verwendet werden können, finden Sie unter vom Datenvertragsserialisierer unterstützte Typen). Die Schemas können anschließend über ein WSDL (Web Services Description Language)-Dokument für andere Benutzer zur Verfügung gestellt werden, die mit Ihrem Dienst zusammenarbeiten müssen.(For more information about the types that can be used, see Types Supported by the Data Contract Serializer.) The schemas can then be exposed through a Web Services Description Language (WSDL) document for use by others who need to interoperate with your service.

Umgekehrt können Sie bei der Erstellung eines Webdiensts, der mit einem bestehenden Webdienst interoperieren muss, den XsdDataContractImporter verwenden, um XML-Schemas umzuwandeln und die CLR-Typen zu erstellen, die die Daten in einer ausgewählten Programmiersprache darstellen.Conversely, if you are creating a Web service that must interoperate with an existing Web service, use the XsdDataContractImporter to transform XML schemas and create the CLR types that represent the data in a selected programming language.

Der XsdDataContractExporter generiert ein XmlSchemaSet-Objekt, das die Auflistung von Schemas enthält.The XsdDataContractExporter generates an XmlSchemaSet object that contains the collection of schemas. Der Zugriff auf den Schemasatz erfolgt über die Schemas-Eigenschaft.Access the set of schemas through the Schemas property.

Hinweis

Um schnell XML-Schemadefinitionsdateien (XSD-Dateien) zu erstellen, die von anderen Webdiensten genutzt werden können, verwenden Sie den XsdDataContractExporter.To quickly generate XML schema definition (XSD) files that other Web services can consume, use the XsdDataContractExporter.

Exportieren von Schemas in ein XmlSchemaSetExporting Schemas Into an XmlSchemaSet

Beim Erstellen einer Instanz der XmlSchemaSet-Klasse, die XML-Schemadateien enthält, sollten Sie Folgendes beachten:To create an instance of the XmlSchemaSet class that contains XML schema files, you should be aware of the following.

Die Gruppe von Typen, die Sie exportieren, wird als interne Menge von Datenverträgen aufgezeichnet.The set of types you are exporting are recorded as an internal set of data contracts. Dies bedeutet, dass Sie die CanExport-Methode mehrmals aufrufen können, um der Schemagruppe neue Typen hinzuzufügen, ohne dass dies zu einer Leistungsverringerung führt, da nur die neuen Typen zur Gruppe hinzugefügt werden.Thus, you can call the CanExport method multiple times to add new types to the schema set without degrading performance because only the new types will be added to the set. Während der Export-Operation werden die vorhandenen Schemas mit den neuen Schemas verglichen, die hinzugefügt werden.During the Export operation, the existing schemas are compared to the new schemas being added. Wenn es Konflikte gibt, wird eine Ausnahme ausgelöst.If there are conflicts, an exception will be thrown. Ein Konflikt wird normalerweise festgestellt, wenn zwei Typen mit demselben Datenvertragsnamen, aber unterschiedlichen Verträgen (verschiedene Member) von derselben XsdDataContractExporter-Instanz exportiert werden.A conflict is usually detected if two types with the same data contract name but different contracts (different members) are exported by the same XsdDataContractExporter instance.

Verwenden des Exporteur-ToolsUsing the Exporter

Es wird empfohlen, diese Klasse wie folgt zu verwenden:A recommended way of using this class is as follows:

  1. Verwenden Sie eine der CanExport- Überladungen, um festzustellen, ob der angegebene Typ oder die angegebene Typgruppe exportiert werden kann.Use one of the CanExport overloads to determine whether the specified type or set of types can be exported. Verwenden Sie eine der Überladungen, die für die Anforderungen geeignet ist.Use one of the overloads that is appropriate to your requirements.

  2. Rufen Sie die entsprechende Export-Methode auf.Call the corresponding Export method.

  3. Rufen Sie die Schemas von der Schemas-Eigenschaft ab.Retrieve the schemas from the Schemas property.

Konstruktoren

XsdDataContractExporter() XsdDataContractExporter() XsdDataContractExporter() XsdDataContractExporter()

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

XsdDataContractExporter(XmlSchemaSet) XsdDataContractExporter(XmlSchemaSet) XsdDataContractExporter(XmlSchemaSet) XsdDataContractExporter(XmlSchemaSet)

Initialisiert eine neue Instanz der XsdDataContractExporter-Klasse mit dem angegebenen Schemasatz.Initializes a new instance of the XsdDataContractExporter class with the specified set of schemas.

Eigenschaften

Options Options Options Options

Ruft einen ExportOptions ab, der Optionen enthält, die für die Exportoperation festgelegt werden können, oder legt diesen fest.Gets or sets an ExportOptions that contains options that can be set for the export operation.

Schemas Schemas Schemas Schemas

Ruft die Auflistung exportierter XML-Schemas ab.Gets the collection of exported XML schemas.

Methoden

CanExport(ICollection<Assembly>) CanExport(ICollection<Assembly>) CanExport(ICollection<Assembly>) CanExport(ICollection<Assembly>)

Ruft einen Wert ab, der angibt, ob ein in einem Satz von Assemblys enthaltener Satz von Common Language Runtime (CLR)-Typen exportiert werden kann.Gets a value that indicates whether the set of .common language runtime (CLR) types contained in a set of assemblies can be exported.

CanExport(ICollection<Type>) CanExport(ICollection<Type>) CanExport(ICollection<Type>) CanExport(ICollection<Type>)

Ruft einen Wert ab, der angibt, ob ein in einem ICollection<T> enthaltener Satz von Common Language Runtime (CLR)-Typen exportiert werden kann.Gets a value that indicates whether the set of .common language runtime (CLR) types contained in a ICollection<T> can be exported.

CanExport(Type) CanExport(Type) CanExport(Type) CanExport(Type)

Ruft einen Wert ab, der angibt, ob der angegebene Common Language Runtime (CLR)-Typ exportiert werden kann.Gets a value that indicates whether the specified common language runtime (CLR) type can be exported.

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Bestimmt, ob das angegebene Objekt mit dem aktuellen Objekt identisch ist.Determines whether the specified object is equal to the current object.

(Inherited from Object)
Export(ICollection<Assembly>) Export(ICollection<Assembly>) Export(ICollection<Assembly>) Export(ICollection<Assembly>)

Transformiert die in der angegebenen Auflistung von Assemblys enthaltenen Typen.Transforms the types contained in the specified collection of assemblies.

Export(ICollection<Type>) Export(ICollection<Type>) Export(ICollection<Type>) Export(ICollection<Type>)

Transformiert die im ICollection<T> enthaltenen, an diese Methode übergebenen Typen.Transforms the types contained in the ICollection<T> passed to this method.

Export(Type) Export(Type) Export(Type) Export(Type)

Transformiert den angegebenen .NET Framework.NET Framework-Typ in ein XSD-Schema (XML Schema Definition Language).Transforms the specified .NET Framework.NET Framework type into an XML schema definition language (XSD) schema.

GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Fungiert als Standardhashfunktion.Serves as the default hash function.

(Inherited from Object)
GetRootElementName(Type) GetRootElementName(Type) GetRootElementName(Type) GetRootElementName(Type)

Gibt den Namen und Namespace der obersten Ebene für den Type zurück.Returns the top-level name and namespace for the Type.

GetSchemaType(Type) GetSchemaType(Type) GetSchemaType(Type) GetSchemaType(Type)

Gibt den XML-Schematyp für den angegebenen Typ zurück.Returns the XML schema type for the specified type.

GetSchemaTypeName(Type) GetSchemaTypeName(Type) GetSchemaTypeName(Type) GetSchemaTypeName(Type)

Gibt den Vertragsnamen und den Vertragsnamespace für den Type zurück.Returns the contract name and contract namespace for the Type.

GetType() GetType() GetType() GetType()

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

(Inherited from Object)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

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

(Inherited from Object)
ToString() ToString() ToString() ToString()

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

(Inherited from Object)

Gilt für:

Siehe auch