XsdDataContractImporter Clase

Definición

Espacio de nombres:

System.Runtime.Serialization

Ensamblado:

System.Runtime.Serialization.dll

Permite la transformación de un conjunto de archivos de esquema XML (.xsd) en los tipos de Common Language Runtime (CLR).

public ref class XsdDataContractImporter

public class XsdDataContractImporter

type XsdDataContractImporter = class

Public Class XsdDataContractImporter

Herencia

Object

XsdDataContractImporter

Ejemplos

En el ejemplo siguiente, se crea un XmlSchemaSet y se llama al método Import para crear una CodeCompileUnit. A continuación se usa CodeCompileUnit para crear archivos de código Visual C# y 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

Comentarios

Use XsdDataContractImporter si está creando un servicio Web que debe interoperar con un servicio Web existente, o si desea crear tipos de contrato de datos a partir de esquemas XML. XsdDataContractImporter transformará un conjunto de esquemas XML y creará los tipos de .NET Framework que representan el contrato de datos en un lenguaje de programación seleccionado. Para crear el código, use las clases en el espacio de nombres System.CodeDom.

A la inversa, use la clase XsdDataContractExporter cuando haya creado un servicio Web que incorpore datos representados por tipos de CLR y cuando deba exportar esquemas XML para cada tipo de datos que vayan a usar otros servicios Web. Es decir, XsdDataContractExporter transforma un conjunto de tipos de CLR en un conjunto de esquemas XML.

Nota

Para generar tipos CLR a partir de esquemas XML en tiempo de diseño, use la Herramienta de utilidad de metadatos de ServiceModel (Svcutil.exe). Para generar código a partir de archivos XSD, use el /dataContractOnly modificador de la herramienta. También puede usar XsdDataContractImporter si necesita más control sobre el proceso o necesita hacerlo mediante programación.

Constructores

XsdDataContractImporter()	Inicializa una nueva instancia de la clase XsdDataContractImporter.
XsdDataContractImporter(CodeCompileUnit)	Inicializa una nueva instancia de la clase XsdDataContractImporter con la CodeCompileUnit que se usara para generar el código de CLR.

Propiedades

CodeCompileUnit	Obtiene CodeCompileUnit usado para almacenar los tipos de CLR generados.
Options	Obtiene o establece ImportOptions que contiene opciones que se pueden establecer para la operación de importación.

Métodos

CanImport(XmlSchemaSet)	Obtiene un valor que indica si los esquemas incluidos en un XmlSchemaSet se pueden transformar en CodeCompileUnit.
CanImport(XmlSchemaSet, ICollection<XmlQualifiedName>)	Obtiene un valor que indica si el conjunto especificado de tipos incluidos en la clase XmlSchemaSet se puede transformar en los tipos de CLR generados en la clase CodeCompileUnit.
CanImport(XmlSchemaSet, XmlQualifiedName)	Obtiene un valor que indica si los esquemas incluidos en un XmlSchemaSet se pueden transformar en CodeCompileUnit.
CanImport(XmlSchemaSet, XmlSchemaElement)	Obtiene un valor que indica si un elemento de esquema específico incluido en un XmlSchemaSet se puede importar.
Equals(Object)	Determina si el objeto especificado es igual que el objeto actual. (Heredado de Object)
GetCodeTypeReference(XmlQualifiedName)	Devuelve CodeTypeReference al tipo de CLR generado para el tipo de esquema con el XmlQualifiedName especificado.
GetCodeTypeReference(XmlQualifiedName, XmlSchemaElement)	Devuelve CodeTypeReference para el elemento XML calificado especificado y el elemento de esquema.
GetHashCode()	Sirve como la función hash predeterminada. (Heredado de Object)
GetKnownTypeReferences(XmlQualifiedName)	Devuelve una lista de objetos CodeTypeReference que representa los tipos conocidos generados al generar código para el tipo de esquema especificado.
GetType()	Obtiene el Type de la instancia actual. (Heredado de Object)
Import(XmlSchemaSet)	Transforma el conjunto especificado de esquemas XML incluido en un XmlSchemaSet en una CodeCompileUnit.
Import(XmlSchemaSet, ICollection<XmlQualifiedName>)	Transforma el conjunto especificado de tipos de esquema incluido en la clase XmlSchemaSet en los tipos de CLR generados en la clase CodeCompileUnit.
Import(XmlSchemaSet, XmlQualifiedName)	Transforma el tipo de esquema XML especificado incluido en XmlSchemaSet en CodeCompileUnit.
Import(XmlSchemaSet, XmlSchemaElement)	Transforma el elemento de esquema especificado en el conjunto de esquemas XML especificados en CodeCompileUnit y devuelve XmlQualifiedName que representa el nombre de contrato de datos para el elemento especificado.
MemberwiseClone()	Crea una copia superficial del Object actual. (Heredado de Object)
ToString()	Devuelve una cadena que representa el objeto actual. (Heredado de Object)

Consulte también

• XsdDataContractExporter
• Utilización de contratos de datos
• Tipos admitidos por el serializador de contratos de datos