XsdDataContractImporter Třída

Reference

Definice

Obor názvů:: System.Runtime.Serialization

Sestavení:: System.Runtime.Serialization.dll

Důležité

Některé informace platí pro předběžně vydaný produkt, který se může zásadně změnit, než ho výrobce nebo autor vydá. Microsoft neposkytuje žádné záruky, výslovné ani předpokládané, týkající se zde uváděných informací.

Umožňuje transformaci sady souborů schématu XML (.xsd) na typy Common Language Runtime (CLR).

public ref class XsdDataContractImporter

public class XsdDataContractImporter

type XsdDataContractImporter = class

Public Class XsdDataContractImporter

Dědičnost: Object
XsdDataContractImporter

Příklady

Následující příklad vytvoří XmlSchemaSet a zavolá metodu Import , která vytvoří CodeCompileUnit. Potom CodeCompileUnit se používá k vytvoření souborů kódu jazyka Visual C# i 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

Poznámky

XsdDataContractImporter Pokud vytváříte webovou službu, která musí spolupracovat s existující webovou službou, nebo pokud chcete vytvořit typy kontraktů dat ze schémat XML. XsdDataContractImporter transformuje sadu schémat XML a vytvoří typy rozhraní .NET Framework, které představují datový kontrakt ve vybraném programovacím jazyce. K vytvoření kódu použijte třídy v System.CodeDom oboru názvů .

Naopak třídu použijte XsdDataContractExporter , pokud jste vytvořili webovou službu, která zahrnuje data reprezentovaná typy CLR, a když potřebujete exportovat schémata XML pro každý datový typ, které mají být využívány jinými webovými službami. To znamená, XsdDataContractExporter že transformuje sadu typů CLR na sadu schémat XML.

Poznámka

Pokud chcete vygenerovat typy CLR ze schémat XML v době návrhu, použijte nástroj ServiceModel Metadata Utility Tool (Svcutil.exe). Pokud chcete vygenerovat kód ze souborů XSD, použijte /dataContractOnly přepínač nástroje . Můžete také použít XsdDataContractImporter , pokud potřebujete větší kontrolu nad procesem nebo to udělat programově.

Konstruktory

XsdDataContractImporter()	Inicializuje novou instanci XsdDataContractImporter třídy .
XsdDataContractImporter(CodeCompileUnit)	Inicializuje novou instanci XsdDataContractImporter třídy pomocí CodeCompileUnit , která se použije ke generování kódu CLR.

Vlastnosti

CodeCompileUnit	CodeCompileUnit Získá pro ukládání vygenerovaných typů CLR.
Options	Získá nebo nastaví , ImportOptions který obsahuje nastavitelné možnosti pro operaci importu.

Metody

CanImport(XmlSchemaSet)	Získá hodnotu, která označuje, zda schémata obsažená v objektu XmlSchemaSet lze transformovat na CodeCompileUnit.
CanImport(XmlSchemaSet, ICollection<XmlQualifiedName>)	Získá hodnotu, která označuje, zda zadanou sadu typů obsažených v objektu XmlSchemaSet lze transformovat na typy CLR vygenerované na CodeCompileUnit.
CanImport(XmlSchemaSet, XmlQualifiedName)	Získá hodnotu, která označuje, zda schémata obsažená v objektu XmlSchemaSet lze transformovat na CodeCompileUnit.
CanImport(XmlSchemaSet, XmlSchemaElement)	Získá hodnotu, která označuje, zda konkrétní prvek schématu obsažený v objektu XmlSchemaSet lze importovat.
Equals(Object)	Určí, zda se zadaný objekt rovná aktuálnímu objektu. (Zděděno od Object)
GetCodeTypeReference(XmlQualifiedName)	Vrátí hodnotu CodeTypeReference na typ CLR vygenerovaný pro typ schématu se zadaným XmlQualifiedNameparametrem .
GetCodeTypeReference(XmlQualifiedName, XmlSchemaElement)	Vrátí hodnotu CodeTypeReference pro zadaný kvalifikovaný element XML a element schématu.
GetHashCode()	Slouží jako výchozí hashovací funkce. (Zděděno od Object)
GetKnownTypeReferences(XmlQualifiedName)	Vrátí seznam CodeTypeReference objektů, který představuje známé typy vygenerované při generování kódu pro zadaný typ schématu.
GetType()	Type Získá z aktuální instance. (Zděděno od Object)
Import(XmlSchemaSet)	Transformuje zadanou sadu schémat XML obsažených v objektu XmlSchemaSet na CodeCompileUnit.
Import(XmlSchemaSet, ICollection<XmlQualifiedName>)	Transformuje zadanou sadu typů schémat obsažených v objektu XmlSchemaSet na typy CLR generované na CodeCompileUnit.
Import(XmlSchemaSet, XmlQualifiedName)	Transformuje zadaný typ schématu XML obsažený v objektu XmlSchemaSet na CodeCompileUnit.
Import(XmlSchemaSet, XmlSchemaElement)	Transformuje zadaný prvek schématu v sadě zadaných schémat XML na CodeCompileUnit a vrátí , XmlQualifiedName který představuje název kontraktu dat pro zadaný prvek.
MemberwiseClone()	Vytvoří mělkou kopii aktuálního Objectsouboru . (Zděděno od Object)
ToString()	Vrátí řetězec, který představuje aktuální objekt. (Zděděno od Object)

Platí pro