XsdDataContractExporter Class

Allows the transformation of a set of .NET Framework types that are used in data contracts into an XML schema file (.xsd).

System.Object
  System.Runtime.Serialization.XsdDataContractExporter

Namespace:  System.Runtime.Serialization
Assembly:  System.Runtime.Serialization (in System.Runtime.Serialization.dll)

'Declaration
Public Class XsdDataContractExporter

The XsdDataContractExporter type exposes the following members.

  NameDescription
Public methodXsdDataContractExporterInitializes a new instance of the XsdDataContractExporter class.
Public methodXsdDataContractExporter(XmlSchemaSet)Initializes a new instance of the XsdDataContractExporter class with the specified set of schemas.
Top

  NameDescription
Public propertyOptionsGets or sets an ExportOptions that contains options that can be set for the export operation.
Public propertySchemasGets the collection of exported XML schemas.
Top

  NameDescription
Public methodCanExport(ICollection(Of Assembly))Gets a value that indicates whether the set of .common language runtime (CLR) types contained in a set of assemblies can be exported.
Public methodCanExport(ICollection(Of Type))Gets a value that indicates whether the set of .common language runtime (CLR) types contained in a ICollection(Of T) can be exported.
Public methodCanExport(Type)Gets a value that indicates whether the specified common language runtime (CLR) type can be exported.
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodExport(ICollection(Of Assembly))Transforms the types contained in the specified collection of assemblies.
Public methodExport(ICollection(Of Type))Transforms the types contained in the ICollection(Of T) passed to this method.
Public methodExport(Type)Transforms the specified .NET Framework type into an XML schema definition language (XSD) schema.
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetRootElementNameReturns the top-level name and namespace for the Type.
Public methodGetSchemaTypeReturns the XML schema type for the specified type.
Public methodGetSchemaTypeNameReturns the contract name and contract namespace for the Type.
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

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.

NoteNote

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 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:

  1. Use one of the CanExport overloads to determine whether the specified type or set of types can be exported. Use one of the overloads that is appropriate to your requirements.

  2. Call the corresponding Export method.

  3. Retrieve the schemas from the Schemas property.

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

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft