XsdDataContractImporter Kelas

Definisi

Ruang nama:

System.Runtime.Serialization

Rakitan:

System.Runtime.Serialization.Schema.dll

Paket:

System.Runtime.Serialization.Schema v9.0.0-preview.3.24172.9

Sumber:

XsdDataContractImporter.cs

Memungkinkan transformasi sekumpulan file skema XML (.xsd) menjadi jenis runtime bahasa umum (CLR).

public ref class XsdDataContractImporter

public class XsdDataContractImporter

type XsdDataContractImporter = class

Public Class XsdDataContractImporter

Warisan

Object

XsdDataContractImporter

Contoh

Contoh berikut membuat XmlSchemaSet dan memanggil Import metode untuk membuat CodeCompileUnit. CodeCompileUnit kemudian digunakan untuk membuat file kode Visual C# dan 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

Keterangan

XsdDataContractImporter Gunakan jika Anda membuat layanan Web yang harus beroperasi dengan layanan Web yang ada, atau untuk membuat jenis kontrak data dari skema XML. XsdDataContractImporterakan mengubah sekumpulan skema XML dan membuat jenis .NET Framework yang mewakili kontrak data dalam bahasa pemrograman yang dipilih. Untuk membuat kode, gunakan kelas di System.CodeDom namespace.

Sebaliknya, gunakan XsdDataContractExporter kelas ketika Anda telah membuat layanan Web yang menggabungkan data yang diwakili oleh jenis CLR dan ketika Anda perlu mengekspor skema XML untuk setiap jenis data yang akan digunakan oleh layanan Web lainnya. Artinya, XsdDataContractExporter mengubah sekumpulan jenis CLR menjadi sekumpulan skema XML.

Catatan

Untuk menghasilkan jenis CLR dari skema XML pada waktu desain, gunakan ServiceModel Metadata Utility Tool (Svcutil.exe). Untuk membuat kode dari file XSD, gunakan sakelar /dataContractOnly alat. Anda juga dapat menggunakan XsdDataContractImporter jika Anda membutuhkan kontrol lebih besar atas proses atau perlu melakukannya secara terprogram.

Konstruktor

XsdDataContractImporter()	Menginisialisasi instans baru kelas XsdDataContractImporter.
XsdDataContractImporter(CodeCompileUnit)	Menginisialisasi instans XsdDataContractImporter baru kelas dengan CodeCompileUnit yang akan digunakan untuk menghasilkan kode CLR.

Properti

CodeCompileUnit	Digunakan untuk menyimpan jenis CLR yang CodeCompileUnit dihasilkan.
Options	Mendapatkan atau mengatur yang ImportOptions berisi opsi yang dapat diatur untuk operasi impor.

Metode

CanImport(XmlSchemaSet)	Mendapatkan nilai yang menunjukkan apakah skema yang terkandung dalam XmlSchemaSet dapat diubah menjadi CodeCompileUnit.
CanImport(XmlSchemaSet, ICollection<XmlQualifiedName>)	Mendapatkan nilai yang menunjukkan apakah sekumpulan jenis yang ditentukan yang terkandung dalam XmlSchemaSet dapat diubah menjadi jenis CLR yang dihasilkan menjadi CodeCompileUnit.
CanImport(XmlSchemaSet, XmlQualifiedName)	Mendapatkan nilai yang menunjukkan apakah skema yang terkandung dalam XmlSchemaSet dapat diubah menjadi CodeCompileUnit.
CanImport(XmlSchemaSet, XmlSchemaElement)	Mendapatkan nilai yang menunjukkan apakah elemen skema tertentu yang XmlSchemaSet terkandung dalam dapat diimpor.
Equals(Object)	Menentukan apakah objek yang ditentukan sama dengan objek saat ini. (Diperoleh dari Object)
GetCodeTypeReference(XmlQualifiedName)	Mengembalikan ke jenis CLR yang CodeTypeReference dihasilkan untuk jenis skema dengan yang ditentukan XmlQualifiedName.
GetCodeTypeReference(XmlQualifiedName, XmlSchemaElement)	Mengembalikan CodeTypeReference untuk elemen dan elemen skema yang memenuhi syarat XML yang ditentukan.
GetHashCode()	Berfungsi sebagai fungsi hash default. (Diperoleh dari Object)
GetKnownTypeReferences(XmlQualifiedName)	Mengembalikan daftar CodeTypeReference objek yang mewakili jenis yang diketahui yang dihasilkan saat membuat kode untuk jenis skema yang ditentukan.
GetType()	Mendapatkan dari instans Type saat ini. (Diperoleh dari Object)
Import(XmlSchemaSet)	Mengubah kumpulan skema XML yang ditentukan yang terkandung dalam menjadi XmlSchemaSetCodeCompileUnit.
Import(XmlSchemaSet, ICollection<XmlQualifiedName>)	Mengubah sekumpulan jenis skema yang ditentukan yang XmlSchemaSet terkandung dalam jenis CLR yang dihasilkan menjadi CodeCompileUnit.
Import(XmlSchemaSet, XmlQualifiedName)	Mengubah jenis skema XML yang ditentukan yang terkandung dalam menjadi XmlSchemaSetCodeCompileUnit.
Import(XmlSchemaSet, XmlSchemaElement)	Mengubah elemen skema yang ditentukan dalam kumpulan skema XML yang ditentukan menjadi CodeCompileUnit dan mengembalikan XmlQualifiedName yang mewakili nama kontrak data untuk elemen yang ditentukan.
MemberwiseClone()	Membuat salinan dangkal dari saat ini Object. (Diperoleh dari Object)
ToString()	Mengembalikan string yang mewakili objek saat ini. (Diperoleh dari Object)

Lihat juga

• XsdDataContractExporter
• Menggunakan Kontrak Data
• Jenis yang Didukung oleh Serializer Kontrak Data