XsdDataContractImporter Clase

Definición

Permite la transformación de un conjunto de archivos de esquema XML (.xsd) en los tipos de Common Language Runtime (CLR).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
Herencia
XsdDataContractImporter

Ejemplos

En el ejemplo siguiente, se crea un XmlSchemaSet y se llama al método Import para crear una CodeCompileUnit.The following example creates an XmlSchemaSet and calls the Import method to create a CodeCompileUnit. A continuación se usa CodeCompileUnit para crear archivos de código Visual C# y 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 

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.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 transformará un conjunto de esquemas XML y creará tipos .NET Framework.NET Framework que representan el contrato de datos en un lenguaje de programación seleccionado.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. Para crear el código, use las clases en el espacio de nombres System.CodeDom.To create the code, use the classes in the System.CodeDom namespace.

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.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. Es decir, XsdDataContractExporter transforma un conjunto de tipos de CLR en un conjunto de esquemas XML.That is, XsdDataContractExporter transforms a set of CLR types into a set of XML schemas.

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).To generate CLR types from XML schemas at design time, use the ServiceModel Metadata Utility Tool (Svcutil.exe). Para generar código generado a partir de archivos XSD /dataContractOnly , use el modificador de la herramienta.To generated code from XSD files, use the /dataContractOnly switch of the tool. También puede usar XsdDataContractImporter si necesita más control sobre el proceso o necesita hacerlo mediante programación.You can also use the XsdDataContractImporter if you need more control over the process or need to do it programmatically.

Constructores

XsdDataContractImporter()

Inicializa una nueva instancia de la clase XsdDataContractImporter.Initializes a new instance of the XsdDataContractImporter class.

XsdDataContractImporter(CodeCompileUnit)

Inicializa una nueva instancia de la clase XsdDataContractImporter con la CodeCompileUnit que se usara para generar el código de CLR.Initializes a new instance of the XsdDataContractImporter class with the CodeCompileUnit that will be used to generate CLR code.

Propiedades

CodeCompileUnit

Obtiene CodeCompileUnit usado para almacenar los tipos de CLR generados.Gets a CodeCompileUnit used for storing the CLR types generated.

Options

Obtiene o establece ImportOptions que contiene opciones que se pueden establecer para la operación de importación.Gets or sets an ImportOptions that contains settable options for the import operation.

Métodos

CanImport(XmlSchemaSet)

Obtiene un valor que indica si los esquemas incluidos en un XmlSchemaSet se pueden transformar en CodeCompileUnit.Gets a value that indicates whether the schemas contained in an XmlSchemaSet can be transformed into a 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.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)

Obtiene un valor que indica si los esquemas incluidos en un XmlSchemaSet se pueden transformar en CodeCompileUnit.Gets a value that indicates whether the schemas contained in an XmlSchemaSet can be transformed into a CodeCompileUnit.

CanImport(XmlSchemaSet, XmlSchemaElement)

Obtiene un valor que indica si un elemento de esquema específico incluido en un XmlSchemaSet se puede importar.Gets a value that indicates whether a specific schema element contained in an XmlSchemaSet can be imported.

Equals(Object)

Determina si el objeto especificado es igual al objeto actual.Determines whether the specified object is equal to the current object.

(Heredado de Object)
GetCodeTypeReference(XmlQualifiedName)

Devuelve CodeTypeReference al tipo de CLR generado para el tipo de esquema con el XmlQualifiedName especificado.Returns a CodeTypeReference to the CLR type generated for the schema type with the specified XmlQualifiedName.

GetCodeTypeReference(XmlQualifiedName, XmlSchemaElement)

Devuelve CodeTypeReference para el elemento XML calificado especificado y el elemento de esquema.Returns a CodeTypeReference for the specified XML qualified element and schema element.

GetHashCode()

Sirve como la función hash predeterminada.Serves as the default hash function.

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

GetType()

Obtiene el Type de la instancia actual.Gets the Type of the current instance.

(Heredado de Object)
Import(XmlSchemaSet)

Transforma el conjunto especificado de esquemas XML incluido en un XmlSchemaSet en una CodeCompileUnit.Transforms the specified set of XML schemas contained in an XmlSchemaSet into a 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.Transforms the specified set of schema types contained in an XmlSchemaSet into CLR types generated into a CodeCompileUnit.

Import(XmlSchemaSet, XmlQualifiedName)

Transforma el tipo de esquema XML especificado incluido en XmlSchemaSet en CodeCompileUnit.Transforms the specified XML schema type contained in an XmlSchemaSet into a 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.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 superficial del objeto Object actual.Creates a shallow copy of the current Object.

(Heredado de Object)
ToString()

Devuelve una cadena que representa el objeto actual.Returns a string that represents the current object.

(Heredado de Object)

Se aplica a

Consulte también: