XsdDataContractImporter Classe

Definizione

Consente la trasformazione di un set di file di XML Schema (estensione xsd) in tipi CLR (Common Language Runtime).

public ref class XsdDataContractImporter
public class XsdDataContractImporter
type XsdDataContractImporter = class
Public Class XsdDataContractImporter
Ereditarietà
XsdDataContractImporter

Esempio

Nell'esempio seguente viene creata una classe XmlSchemaSet e viene eseguita una chiamata al metodo Import per creare una classe CodeCompileUnit. La classe CodeCompileUnit viene quindi utilizzata per creare sia file di codice Visual C# che Visual Basic.

using System;
using System.CodeDom.Compiler;
using System.CodeDom;
using System.Runtime.Serialization;
using System.IO;
using System.Xml;
using System.Xml.Schema;
using System.Globalization;

namespace XsdContractImporterExample
{
    class Program
    {
        static void Main(string[] args)
        {
            try
            {
                XmlSchemaSet schemas = Export();
                CodeCompileUnit ccu = Import(schemas);
                CompileCode(ccu, "Person.cs");
                CompileCode(ccu, "Person.vb");
            }
            catch (Exception exc)
            {
                Console.WriteLine("{0}: {1}", exc.Message, exc.StackTrace);
            }
            finally
            {
                Console.WriteLine("Press <Enter> to end....");
                Console.ReadLine();
            }
        }

        static XmlSchemaSet Export()
        {
            XsdDataContractExporter ex = new XsdDataContractExporter();
            ex.Export(typeof(Person));
            return ex.Schemas;
        }
        static CodeCompileUnit Import(XmlSchemaSet schemas)
        {

            XsdDataContractImporter imp = new XsdDataContractImporter();

            // The EnableDataBinding option adds a RaisePropertyChanged method to
            // the generated code. The GenerateInternal causes code access to be
            // set to internal.
            ImportOptions iOptions = new ImportOptions();
            iOptions.EnableDataBinding = true;
            iOptions.GenerateInternal = true;
            imp.Options = iOptions;

            if (imp.CanImport(schemas))
            {
                imp.Import(schemas);
                return imp.CodeCompileUnit;
            }
            else
            {
                return null;
            }
        }
        static void CompileCode(CodeCompileUnit ccu, string sourceName)
        {
            CodeDomProvider provider = null;
            FileInfo sourceFile = new FileInfo(sourceName);
            // Select the code provider based on the input file extension, either C# or Visual Basic.
            if (sourceFile.Extension.ToUpper(CultureInfo.InvariantCulture) == ".CS")
            {
                provider = new Microsoft.CSharp.CSharpCodeProvider();
            }
            else if (sourceFile.Extension.ToUpper(CultureInfo.InvariantCulture) == ".VB")
            {
                provider = new Microsoft.VisualBasic.VBCodeProvider();
            }
            else
            {
                Console.WriteLine("Source file must have a .cs or .vb extension");
            }
            if (provider != null)
            {
                CodeGeneratorOptions options = new CodeGeneratorOptions();
                // Set code formatting options to your preference.
                options.BlankLinesBetweenMembers = true;
                options.BracingStyle = "C";

                StreamWriter sw = new StreamWriter(sourceName);
                provider.GenerateCodeFromCompileUnit(ccu, sw, options);
                sw.Close();
            }
        }
    }

    [DataContract]
    public class Person
    {
        [DataMember]
        public string FirstName;

        [DataMember]
        public string LastName;

        public Person(string newFName, string newLName)
        {
            FirstName = newFName;
            LastName = newLName;
        }
    }
}
Imports System.CodeDom.Compiler
Imports System.CodeDom
Imports System.Runtime.Serialization
Imports System.IO
Imports System.Xml
Imports System.Xml.Schema
Imports System.Globalization

Class Program
   
    Shared Sub Main(ByVal args() As String) 
        Try
            Dim schemas As XmlSchemaSet = Export()
            Dim ccu As CodeCompileUnit = Import(schemas)
            CompileCode(ccu, "Person.cs")
            CompileCode(ccu, "Person.vb")
        Catch exc As Exception
            Console.WriteLine("{0}: {1}", exc.Message, exc.StackTrace)
        Finally
            Console.WriteLine("Press <Enter> to end....")
            Console.ReadLine()
        End Try
    
    End Sub 
    
    Shared Function Export() As XmlSchemaSet 
        Dim ex As New XsdDataContractExporter()
        ex.Export(GetType(Person))
        Return ex.Schemas
    End Function
    Shared Function Import(ByVal schemas As XmlSchemaSet) As CodeCompileUnit 

        Dim imp As New XsdDataContractImporter()
       ' The EnableDataBinding option adds a RaisePropertyChanged method to
       ' the generated code. The GenerateInternal causes code access to be
       ' set to internal.
       Dim iOptions As New ImportOptions()
       iOptions.EnableDataBinding = true
       iOptions.GenerateInternal = true
       imp.Options = IOptions

        If imp.CanImport(schemas) Then
            imp.Import(schemas)
            Return imp.CodeCompileUnit
        Else
            Return Nothing
        End If
    End Function

    Shared Sub CompileCode(ByVal ccu As CodeCompileUnit, ByVal sourceName As String) 
        Dim provider As CodeDomProvider = Nothing
        Dim sourceFile As New FileInfo(sourceName)
        ' Select the code provider based on the input file extension, either C# or Visual Basic.
        If sourceFile.Extension.ToUpper(CultureInfo.InvariantCulture) = ".CS" Then
            provider = New Microsoft.CSharp.CSharpCodeProvider()
        ElseIf sourceFile.Extension.ToUpper(CultureInfo.InvariantCulture) = ".VB" Then
            provider = New Microsoft.VisualBasic.VBCodeProvider()
        Else
            Console.WriteLine("Source file must have a .cs or .vb extension")
        End If
        If Not (provider Is Nothing) Then
            Dim options As New CodeGeneratorOptions()
            ' Set code formatting options to your preference. 
            options.BlankLinesBetweenMembers = True
            options.BracingStyle = "C"
            
            Dim sw As New StreamWriter(sourceName)
            provider.GenerateCodeFromCompileUnit(ccu, sw, options)
            sw.Close()
        End If
    
    End Sub
End Class

<DataContract()>  _
Public Class Person
    <DataMember()>  _
    Public FirstName As String
    
    <DataMember()>  _
    Public LastName As String
    
    
    Public Sub New(ByVal newFName As String, ByVal newLName As String) 
        FirstName = newFName
        LastName = newLName
    
    End Sub 
End Class

Commenti

Utilizzare la classe XsdDataContractImporter se si crea un servizio Web che deve interoperare con un servizio Web esistente o per creare tipi di contratto dati da XML Schema. XsdDataContractImporter trasformerà un set di schemi XML e creerà i tipi .NET Framework che rappresentano il contratto di dati in un linguaggio di programmazione selezionato. Per creare il codice, utilizzare le classi dello spazio dei nomi System.CodeDom.

Utilizzare invece 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 di dati che deve essere utilizzato da altri servizi Web. Ciò significa che la classe XsdDataContractExporter trasforma un set di tipi CLR in un set di XML Schema.

Nota

Per generare tipi CLR dagli schemi XML in fase di progettazione, usare lo strumento utilità metadati ServiceModel (Svcutil.exe). Per generare codice da file XSD, usare l'opzione /dataContractOnly dello strumento. È inoltre possibile utilizzare XsdDataContractImporter se è necessario operare un maggiore controllo sul processo o se occorre impostare tale controllo a livello di programmazione.

Costruttori

XsdDataContractImporter()

Inizializza una nuova istanza della classe XsdDataContractImporter.

XsdDataContractImporter(CodeCompileUnit)

Inizializza una nuova istanza della classe XsdDataContractImporter con la classe CodeCompileUnit che verrà utilizzata per generare codice CLR.

Proprietà

CodeCompileUnit

Ottiene una classe CodeCompileUnit utilizzata per archiviare i tipi CLR generati.

Options

Ottiene o imposta una classe ImportOptions che contiene opzioni impostabili per l'operazione di importazione.

Metodi

CanImport(XmlSchemaSet)

Ottiene un valore che indica se gli schemi contenuti in una XmlSchemaSet possono essere trasformati in una CodeCompileUnit.

CanImport(XmlSchemaSet, ICollection<XmlQualifiedName>)

Ottiene un valore che indica se il set di tipi specificato contenuto in una classe XmlSchemaSet può essere trasformato in tipi CLR generati in una classe CodeCompileUnit.

CanImport(XmlSchemaSet, XmlQualifiedName)

Ottiene un valore che indica se gli schemi contenuti in una XmlSchemaSet possono essere trasformati in una CodeCompileUnit.

CanImport(XmlSchemaSet, XmlSchemaElement)

Ottiene un valore che indica se è possibile importare un elemento di schema specifico contenuto in una classe XmlSchemaSet.

Equals(Object)

Determina se l'oggetto specificato è uguale all'oggetto corrente.

(Ereditato da Object)
GetCodeTypeReference(XmlQualifiedName)

Restituisce una classe CodeTypeReference al tipo CLR generato per il tipo di schema con la classe XmlQualifiedName specificata.

GetCodeTypeReference(XmlQualifiedName, XmlSchemaElement)

Restituisce una classe CodeTypeReference per l'elemento qualificato XML e l'elemento dello schema specificati.

GetHashCode()

Funge da funzione hash predefinita.

(Ereditato da Object)
GetKnownTypeReferences(XmlQualifiedName)

Restituisce un elenco di oggetti CodeTypeReference che rappresentano i tipi noti generati durante la generazione di codice per il tipo di schema specificato.

GetType()

Ottiene l'oggetto Type dell'istanza corrente.

(Ereditato da Object)
Import(XmlSchemaSet)

Trasforma il set specificato di XML Schema contenuto in una classe XmlSchemaSet in una classe CodeCompileUnit.

Import(XmlSchemaSet, ICollection<XmlQualifiedName>)

Trasforma il set di tipi di schema specificato contenuto in una classe XmlSchemaSet in tipi CLR generati in una classe CodeCompileUnit.

Import(XmlSchemaSet, XmlQualifiedName)

Trasforma il tipo di XML Schema specificato contenuto in una classe XmlSchemaSet in una classe CodeCompileUnit.

Import(XmlSchemaSet, XmlSchemaElement)

Trasforma l'elemento dello schema specificato nel set di XML Schema specificati in una classe CodeCompileUnit e restituisce una classe XmlQualifiedName che rappresenta il nome del contratto dati per l'elemento specificato.

MemberwiseClone()

Crea una copia superficiale dell'oggetto Object corrente.

(Ereditato da Object)
ToString()

Restituisce una stringa che rappresenta l'oggetto corrente.

(Ereditato da Object)

Si applica a

Vedi anche