XsdDataContractExporter Klas

Definitie

public ref class XsdDataContractExporter

public class XsdDataContractExporter

type XsdDataContractExporter = class

Public Class XsdDataContractExporter

Overname

Object

XsdDataContractExporter

Voorbeelden

In het volgende voorbeeld wordt een exemplaar van de XsdDataContractExporter methode gemaakt en de methode aangeroepen Export(Type) .

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

Opmerkingen

Gebruik de XsdDataContractExporter klasse wanneer u een webservice hebt gemaakt die gegevens bevat die worden vertegenwoordigd door CLR-typen (Common Language Runtime) en wanneer u XML-schema's moet exporteren voor elk type dat door andere webservices moet worden gebruikt. Dat wil gezegd, XsdDataContractExporter transformeert een set CLR-typen in XML-schema's. (Zie Typen die worden ondersteund door de Serializer van het gegevenscontract voor meer informatie over de typen die kunnen worden gebruikt.) De schema's kunnen vervolgens worden weergegeven via een WSDL-document (Web Services Description Language) voor gebruik door anderen die met uw service moeten samenwerken.

Als u echter een webservice maakt die moet samenwerken met een bestaande webservice, gebruikt u het XsdDataContractImporter om XML-schema's te transformeren en de CLR-typen te maken die de gegevens in een geselecteerde programmeertaal vertegenwoordigen.

Hiermee XsdDataContractExporter wordt een XmlSchemaSet object gegenereerd dat de verzameling schema's bevat. Toegang krijgen tot de reeks schemas door middel van de Schemas() eigenschap.

Schema's exporteren naar een XmlSchemaSet

Als u een exemplaar wilt maken van de XmlSchemaSet klasse die XML-schemabestanden bevat, moet u rekening houden met het volgende.

De set typen die u exporteert, worden vastgelegd als een interne set gegevenscontracten. U kunt de CanExport methode dus meerdere keren aanroepen om nieuwe typen toe te voegen aan de schemaset zonder de prestaties te verminderen, omdat alleen de nieuwe typen worden toegevoegd aan de set. Tijdens de Export bewerking worden de bestaande schema's vergeleken met de nieuwe schema's die worden toegevoegd. Als er conflicten zijn, wordt er een uitzondering gegenereerd. Er wordt meestal een conflict gedetecteerd als twee typen met dezelfde naam van het gegevenscontract, maar verschillende contracten (verschillende leden) door hetzelfde XsdDataContractExporter exemplaar worden geëxporteerd.

De exporteur gebruiken

Een aanbevolen manier om deze klasse te gebruiken is als volgt:

1. Gebruik een van de CanExport overbelastingen om te bepalen of het opgegeven type of de typeverzameling geëxporteerd kan worden. Gebruik een van de overbelastingen die geschikt zijn voor uw vereisten.

2. Roep de bijbehorende Export methode aan.

3. Haal de schema's op uit de Schemas eigenschap.

Zie ook

• DataContractSerializer
• XsdDataContractImporter
• Typen die worden ondersteund door de Gegevenscontract-serializer
• Serialisatie en deserialisatie