XsdDataContractImporter Classe

Référence

Définition

Espace de noms:: System.Runtime.Serialization

Assembly:: System.Runtime.Serialization.dll

Important

Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.

Permet la transformation d'un ensemble de fichiers de schéma XML (.xsd) dans des types CLR (Common Language Runtime).

public ref class XsdDataContractImporter

public class XsdDataContractImporter

type XsdDataContractImporter = class

Public Class XsdDataContractImporter

Héritage: Object
XsdDataContractImporter

Exemples

L'exemple suivant crée un XmlSchemaSet et appelle la méthode Import pour créer un CodeCompileUnit. Le CodeCompileUnit est alors utilisé pour créer des fichiers de code Visual C# et 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

Remarques

Utilisez le XsdDataContractImporter si vous créez un service Web qui doit interagir avec un service Web existant ou pour créer des types de contrat de données à partir des schémas XML. XsdDataContractImporter transforme un ensemble de schémas XML et crée les types .NET Framework qui représentent le contrat de données dans un langage de programmation sélectionné. Pour créer le code, utilisez les classes dans l'espace de noms System.CodeDom.

Inversement, utilisez la classe XsdDataContractExporter lorsque vous avez créé un service Web qui incorpore des données représentées par les types CLR et lorsque vous devez exporter des schémas XML pour chaque type de données à consommer par d'autres services Web. Autrement dit, XsdDataContractExporter transforme un ensemble de types CLR en un jeu de schémas XML.

Remarque

Pour générer des types CLR à partir de schémas XML au moment de la conception, utilisez l’outil Utilitaire de métadonnées ServiceModel (Svcutil.exe). Pour générer du code à partir de fichiers XSD, utilisez le /dataContractOnly commutateur de l’outil. Vous pouvez également utiliser le XsdDataContractImporter si vous avez besoin de plus contrôler le processus ou que vous avez besoin de le faire par programme.

Constructeurs

XsdDataContractImporter()	Initialise une nouvelle instance de la classe XsdDataContractImporter.
XsdDataContractImporter(CodeCompileUnit)	Initialise une nouvelle instance de la classe XsdDataContractImporter avec le CodeCompileUnit qui sera utilisé pour générer le code CLR.

Propriétés

CodeCompileUnit	Obtient un CodeCompileUnit utilisé pour stocker les types CLR générés.
Options	Obtient ou définit un ImportOptions qui contient des options définissables pour l'opération d'importation.

Méthodes

CanImport(XmlSchemaSet)	Obtient une valeur qui indique si les schémas contenus dans un XmlSchemaSet peuvent être transformés en un CodeCompileUnit.
CanImport(XmlSchemaSet, ICollection<XmlQualifiedName>)	Obtient une valeur qui indique si l'ensemble spécifié de types contenu dans un XmlSchemaSet peut être transformé en types CLR générés dans un CodeCompileUnit.
CanImport(XmlSchemaSet, XmlQualifiedName)	Obtient une valeur qui indique si les schémas contenus dans un XmlSchemaSet peuvent être transformés en un CodeCompileUnit.
CanImport(XmlSchemaSet, XmlSchemaElement)	Obtient une valeur qui indique si un élément de schéma spécifique contenu dans un XmlSchemaSet peut être importé.
Equals(Object)	Détermine si l'objet spécifié est égal à l'objet actuel. (Hérité de Object)
GetCodeTypeReference(XmlQualifiedName)	Retourne un CodeTypeReference au type CLR généré pour le type de schéma avec le XmlQualifiedNamespécifié.
GetCodeTypeReference(XmlQualifiedName, XmlSchemaElement)	Retourne un CodeTypeReference pour l'élément qualifié XML spécifié et l'élément de schéma.
GetHashCode()	Fait office de fonction de hachage par défaut. (Hérité de Object)
GetKnownTypeReferences(XmlQualifiedName)	Retourne une liste d'objets CodeTypeReference qui représente les types connus générés lors de la génération du code pour le type de schéma spécifié.
GetType()	Obtient le Type de l'instance actuelle. (Hérité de Object)
Import(XmlSchemaSet)	Transforme le jeu de schémas XML spécifié contenu dans un XmlSchemaSet en un CodeCompileUnit.
Import(XmlSchemaSet, ICollection<XmlQualifiedName>)	Transforme l'ensemble spécifié de types de schémas contenu dans un XmlSchemaSet en types CLR générés dans un CodeCompileUnit.
Import(XmlSchemaSet, XmlQualifiedName)	Transforme le type de schéma XML spécifié contenu dans un XmlSchemaSet en un CodeCompileUnit.
Import(XmlSchemaSet, XmlSchemaElement)	Transforme l'élément de schéma spécifié dans le jeu de schémas XML spécifiés en un CodeCompileUnit et retourne un XmlQualifiedName qui représente le nom de contrat de données pour l'élément spécifié.
MemberwiseClone()	Crée une copie superficielle du Object actuel. (Hérité de Object)
ToString()	Retourne une chaîne qui représente l'objet actuel. (Hérité de Object)

S’applique à