XsdDataContractImporter Classe

Definizione

Consente la trasformazione di un set di file di XML Schema (estensione xsd) in tipi CLR (Common Language Runtime).Allows the transformation of a set of XML schema files (.xsd) into common language runtime (CLR) types.

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

Esempi

Nell'esempio seguente viene creata una classe XmlSchemaSet e viene eseguita una chiamata al metodo Import per creare una classe CodeCompileUnit.The following example creates an XmlSchemaSet and calls the Import method to create a CodeCompileUnit. La classe CodeCompileUnit viene quindi utilizzata per creare sia file di codice Visual C# che Visual Basic.The CodeCompileUnit is then used to create both Visual C# and Visual Basic code files.

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.Use the XsdDataContractImporter if you are creating a Web service that must interoperate with an existing Web service, or to create data contract types from XML schemas. XsdDataContractImporter trasformerà un set di XML Schema e creerà i tipi .NET Framework.NET Framework che rappresentano il contratto dati in un linguaggio di programmazione selezionato.XsdDataContractImporter will transform a set of XML schemas and create the .NET Framework.NET Framework types that represent the data contract in a selected programming language. Per creare il codice, utilizzare le classi dello spazio dei nomi System.CodeDom.To create the code, use the classes in the System.CodeDom namespace.

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.Conversely, use the XsdDataContractExporter class when you have created a Web service that incorporates data represented by CLR types and when you need to export XML schemas for each data type to be consumed by other Web services. Ciò significa che la classe XsdDataContractExporter trasforma un set di tipi CLR in un set di XML Schema.That is, XsdDataContractExporter transforms a set of CLR types into a set of XML schemas.

Nota

Per generare tipi CLR da XML Schema in fase di progettazione, utilizzare lo strumento ServiceModel Metadata Utility Tool (Svcutil. exe).To generate CLR types from XML schemas at design time, use the ServiceModel Metadata Utility Tool (Svcutil.exe). Per generare codice da file XSD, utilizzare l' /dataContractOnly opzione dello strumento.To generated code from XSD files, use the /dataContractOnly switch of the tool. È inoltre possibile utilizzare XsdDataContractImporter se è necessario operare un maggiore controllo sul processo o se occorre impostare tale controllo a livello di programmazione.You can also use the XsdDataContractImporter if you need more control over the process or need to do it programmatically.

Costruttori

XsdDataContractImporter()

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

XsdDataContractImporter(CodeCompileUnit)

Inizializza una nuova istanza della classe XsdDataContractImporter con la classe CodeCompileUnit che verrà utilizzata per generare codice CLR.Initializes a new instance of the XsdDataContractImporter class with the CodeCompileUnit that will be used to generate CLR code.

Proprietà

CodeCompileUnit

Ottiene una classe CodeCompileUnit utilizzata per archiviare i tipi CLR generati.Gets a CodeCompileUnit used for storing the CLR types generated.

Options

Ottiene o imposta una classe ImportOptions che contiene opzioni impostabili per l'operazione di importazione.Gets or sets an ImportOptions that contains settable options for the import operation.

Metodi

CanImport(XmlSchemaSet)

Ottiene un valore che indica se gli schemi contenuti in una XmlSchemaSet possono essere trasformati in una CodeCompileUnit.Gets a value that indicates whether the schemas contained in an XmlSchemaSet can be transformed into a 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.Gets a value that indicates whether the specified set of types contained in an XmlSchemaSet can be transformed into CLR types generated into a CodeCompileUnit.

CanImport(XmlSchemaSet, XmlQualifiedName)

Ottiene un valore che indica se gli schemi contenuti in una XmlSchemaSet possono essere trasformati in una CodeCompileUnit.Gets a value that indicates whether the schemas contained in an XmlSchemaSet can be transformed into a CodeCompileUnit.

CanImport(XmlSchemaSet, XmlSchemaElement)

Ottiene un valore che indica se è possibile importare un elemento di schema specifico contenuto in una classe XmlSchemaSet.Gets a value that indicates whether a specific schema element contained in an XmlSchemaSet can be imported.

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)
GetCodeTypeReference(XmlQualifiedName)

Restituisce una classe CodeTypeReference al tipo CLR generato per il tipo di schema con la classe XmlQualifiedName specificata.Returns a CodeTypeReference to the CLR type generated for the schema type with the specified XmlQualifiedName.

GetCodeTypeReference(XmlQualifiedName, XmlSchemaElement)

Restituisce una classe CodeTypeReference per l'elemento qualificato XML e l'elemento dello schema specificati.Returns a CodeTypeReference for the specified XML qualified element and schema element.

GetHashCode()

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

(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.Returns a list of CodeTypeReference objects that represents the known types generated when generating code for the specified schema type.

GetType()

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

(Ereditato da Object)
Import(XmlSchemaSet)

Trasforma il set specificato di XML Schema contenuto in una classe XmlSchemaSet in una classe CodeCompileUnit.Transforms the specified set of XML schemas contained in an XmlSchemaSet into a 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.Transforms the specified set of schema types contained in an XmlSchemaSet into CLR types generated into a CodeCompileUnit.

Import(XmlSchemaSet, XmlQualifiedName)

Trasforma il tipo di XML Schema specificato contenuto in una classe XmlSchemaSet in una classe CodeCompileUnit.Transforms the specified XML schema type contained in an XmlSchemaSet into a 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.Transforms the specified schema element in the set of specified XML schemas into a CodeCompileUnit and returns an XmlQualifiedName that represents the data contract name for the specified element.

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