XsdDataContractExporter Classe

Definizione

Consente la trasformazione di un set di tipi .NET Framework usati in contratti dati in un file XML Schema (con estensione 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
Ereditarietà
XsdDataContractExporter

Esempi

Nell'esempio seguente viene creata un'istanza della classe XsdDataContractExporter e viene chiamato il metodo Export(Type).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

Commenti

Utilizzare la classe XsdDataContractExporter quando è stato creato un servizio Web che incorpora dati rappresentati da tipi CLR (Common Language Runtime) e quando è necessario esportare XML Schema per ogni tipo che deve essere utilizzato da altri servizi Web.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. Ciò significa che XsdDataContractExporter trasforma un set di tipi CLR in XML Schema.That is, XsdDataContractExporter transforms a set of CLR types into XML schemas. Per ulteriori informazioni sui tipi che è possibile utilizzare, vedere tipi supportati dal serializzatore di contratti dati. Gli schemi possono quindi essere esposti attraverso un documento WSDL (Web Services Description Language) per l'utilizzo da parte di altri utenti che devono interoperare con il servizio.(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.

Inversamente, se si sta creando un servizio Web che deve interoperare con un servizio Web esistente, utilizzare la classe XsdDataContractImporter per trasformare XML Schema e creare i tipi CLR che rappresentano i dati in un linguaggio di programmazione selezionato.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.

La classe XsdDataContractExporter genera un oggetto XmlSchemaSet che contiene la raccolta di schemi.The XsdDataContractExporter generates an XmlSchemaSet object that contains the collection of schemas. Accedere al set di schemi mediante la proprietà Schemas.Access the set of schemas through the Schemas property.

Nota

Per generare rapidamente file XSD (XML Schema Definition) che possano essere utilizzati da altri servizi Web, utilizzare la classe XsdDataContractExporter.To quickly generate XML schema definition (XSD) files that other Web services can consume, use the XsdDataContractExporter.

Esportazione di schemi in una classe XmlSchemaSetExporting Schemas Into an XmlSchemaSet

Per creare un'istanza della classe XmlSchemaSet che contenga file di XML Schema, è necessario tenere presente quanto segue.To create an instance of the XmlSchemaSet class that contains XML schema files, you should be aware of the following.

Il set di tipi da esportare viene registrato come un set di contratti dati interno.The set of types you are exporting are recorded as an internal set of data contracts. Per aggiungere nuovi tipi allo schema impostato è pertanto possibile chiamare il metodo CanExport più volte senza compromettere le prestazioni in quanto verranno aggiunti al set solo i nuovi tipi.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. Durante l'operazione Export, gli schemi esistenti vengono confrontati ai nuovi schemi da aggiungere.During the Export operation, the existing schemas are compared to the new schemas being added. In caso di conflitto viene generata un'eccezione.If there are conflicts, an exception will be thrown. Un conflitto si verifica in genere se due tipi con lo stesso nome di contratto dati ma con contratti diversi (membri diversi) vengono esportati dalla stessa istanza XsdDataContractExporter.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.

Utilizzo dell'utilità di esportazioneUsing the Exporter

Di seguito è descritta una modalità di utilizzo consigliata per questa classe:A recommended way of using this class is as follows:

  1. Utilizzare uno degli CanExport per determinare se il tipo o il set di tipi specificato può essere esportato.Use one of the CanExport overloads to determine whether the specified type or set of types can be exported. Utilizzare uno degli overload appropriato alle esigenze specifiche.Use one of the overloads that is appropriate to your requirements.

  2. Chiamare il metodo Export corrispondente.Call the corresponding Export method.

  3. Recuperare gli schemi dalla proprietà Schemas.Retrieve the schemas from the Schemas property.

Costruttori

XsdDataContractExporter()

Inizializza una nuova istanza della classe XsdDataContractExporter.Initializes a new instance of the XsdDataContractExporter class.

XsdDataContractExporter(XmlSchemaSet)

Inizializza una nuova istanza della classe XsdDataContractExporter con il set di schemi specificato.Initializes a new instance of the XsdDataContractExporter class with the specified set of schemas.

Proprietà

Options

Ottiene o imposta un oggetto ExportOptions contenente le opzioni che è possibile impostare per l'operazione di esportazione.Gets or sets an ExportOptions that contains options that can be set for the export operation.

Schemas

Ottiene la raccolta di XML Schema esportati.Gets the collection of exported XML schemas.

Metodi

CanExport(ICollection<Assembly>)

Ottiene un valore che indica se il set di tipi CLR contenuto in un set di assembly può essere esportato.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>)

Ottiene un valore che indica se il set di tipi CLR (Common Language Runtime ) contenuto in un'interfaccia ICollection<T> può essere esportato.Gets a value that indicates whether the set of .common language runtime (CLR) types contained in a ICollection<T> can be exported.

CanExport(Type)

Ottiene un valore che indica se il tipo CLR (Commom Language Runtime) specificato può essere esportato.Gets a value that indicates whether the specified common language runtime (CLR) type can be exported.

Equals(Object)

Determina se l'oggetto specificato è uguale all'oggetto corrente.Determines whether the specified object is equal to the current object.

(Ereditato da Object)
Export(ICollection<Assembly>)

Trasforma i tipi inclusi nella raccolta di assembly specificata.Transforms the types contained in the specified collection of assemblies.

Export(ICollection<Type>)

Trasforma i tipi inclusi nell'oggetto ICollection<T> passato a questo metodo.Transforms the types contained in the ICollection<T> passed to this method.

Export(Type)

Trasforma il tipo .NET Framework.NET Framework specificato in uno schema XSD (XML Definition Language).Transforms the specified .NET Framework.NET Framework type into an XML schema definition language (XSD) schema.

GetHashCode()

Funge da funzione hash predefinita.Serves as the default hash function.

(Ereditato da Object)
GetRootElementName(Type)

Restituisce il nome e lo spazio dei nomi di primo livello per Type.Returns the top-level name and namespace for the Type.

GetSchemaType(Type)

Restituisce il tipo di XML Schema per il tipo specificato.Returns the XML schema type for the specified type.

GetSchemaTypeName(Type)

Restituisce il nome e lo spazio dei nomi del contratto per Type.Returns the contract name and contract namespace for the Type.

GetType()

Ottiene l'oggetto Type dell'istanza corrente.Gets the Type of the current instance.

(Ereditato da Object)
MemberwiseClone()

Crea una copia superficiale dell'oggetto Object corrente.Creates a shallow copy of the current Object.

(Ereditato da Object)
ToString()

Restituisce una stringa che rappresenta l'oggetto corrente.Returns a string that represents the current object.

(Ereditato da Object)

Si applica a

Vedi anche