XsdDataContractExporter Class
Allows the transformation of a set of .NET Framework types that are used in data contracts into an XML schema file (.xsd).
Assembly: System.Runtime.Serialization (in System.Runtime.Serialization.dll)
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. That is, XsdDataContractExporter transforms a set of CLR types into XML schemas. (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.
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.
The XsdDataContractExporter generates an XmlSchemaSet object that contains the collection of schemas. Access the set of schemas through the Schemas property.
Note: |
|---|
To quickly generate XML schema definition (XSD) files that other Web services can consume, use the XsdDataContractExporter. |
Exporting Schemas Into an XmlSchemaSet
To create an instance of the XmlSchemaSet class that contains XML schema files, you should be aware of the following.
The set of types you are exporting are recorded as an internal set of data contracts. 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. During the Export(IListAssembly) operation, the existing schemas are compared to the new schemas being added. If there are conflicts, an exception will be thrown. 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.
Using the Exporter
A recommended way of using this class is as follows:
The following example creates an instance of the XsdDataContractExporter and calls the Export(Type) method.
Imports System 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
Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003
The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Note: