XsdDataContractImporter クラス

定義

名前空間:

System.Runtime.Serialization

アセンブリ:

System.Runtime.Serialization.dll

XML スキーマ ファイル (.xsd) のセットを共通言語ランタイム (CLR) 型に変換することを可能にします。

public ref class XsdDataContractImporter

public class XsdDataContractImporter

type XsdDataContractImporter = class

Public Class XsdDataContractImporter

継承

Object

XsdDataContractImporter

例

XmlSchemaSet を作成し、Import メソッドを呼び出して CodeCompileUnit を作成する例を次に示します。 その後、CodeCompileUnit を使用して Visual C# コード ファイルと 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

注釈

既存の Web サービスを組み込む必要がある Web サービス、または XML スキーマからデータ コントラクト型を作成する場合は、XsdDataContractImporter を使用します。 XsdDataContractImporterは、一連の XML スキーマを変換し、選択したプログラミング言語でデータ コントラクトを表す.NET Framework型を作成します。 コードを作成するには、System.CodeDom 名前空間を使用します。

逆に、CLR 型で表されるデータを組み込む Web サービスを作成する場合、および他の Web サービスが消費できるように各データ型の XML スキーマをエクスポートする必要がある場合は、XsdDataContractExporter クラスを使用します。 つまり、XsdDataContractExporter は、CLR 型のセットを XML スキーマのセットに変換します。

注意

デザイン時に XML スキーマから CLR 型を生成するには、 ServiceModel メタデータ ユーティリティ ツール (Svcutil.exe) を使用します。 XSD ファイルからコードを生成するには、ツールのスイッチを /dataContractOnly 使用します。 この処理をさらに制御する必要がある、またはプログラムによって実行する必要がある場合は、XsdDataContractImporter を使用することもできます。

コンストラクター

XsdDataContractImporter()	XsdDataContractImporter クラスの新しいインスタンスを初期化します。
XsdDataContractImporter(CodeCompileUnit)	CLR コードを生成するために使用される XsdDataContractImporter を使用して、CodeCompileUnit クラスの新しいインスタンスを初期化します。

プロパティ

CodeCompileUnit	生成された CLR 型を格納するために使用される CodeCompileUnit を取得します。
Options	インポート操作で設定可能なオプションを含む ImportOptions を取得または設定します。

メソッド

CanImport(XmlSchemaSet)	XmlSchemaSet に含まれているスキーマを CodeCompileUnit に変換できるかどうかを示す値を取得します。
CanImport(XmlSchemaSet, ICollection<XmlQualifiedName>)	XmlSchemaSet に含まれる指定した型のセットが、CodeCompileUnit 内に生成される CLR 型に変換できるかどうかを示す値を取得します。
CanImport(XmlSchemaSet, XmlQualifiedName)	XmlSchemaSet に含まれているスキーマを CodeCompileUnit に変換できるかどうかを示す値を取得します。
CanImport(XmlSchemaSet, XmlSchemaElement)	XmlSchemaSet に含まれる指定したスキーマ要素をインポートできるかどうかを示す値を取得します。
Equals(Object)	指定されたオブジェクトが現在のオブジェクトと等しいかどうかを判断します。 (継承元 Object)
GetCodeTypeReference(XmlQualifiedName)	指定した CodeTypeReference を持つスキーマ型に対して生成された CLR 型への XmlQualifiedName を返します。
GetCodeTypeReference(XmlQualifiedName, XmlSchemaElement)	指定した XML 修飾要素とスキーマ要素の CodeTypeReference を返します。
GetHashCode()	既定のハッシュ関数として機能します。 (継承元 Object)
GetKnownTypeReferences(XmlQualifiedName)	指定したスキーマ型のコードを生成するときに生成される既知の型を表す CodeTypeReference オブジェクトのリストを返します。
GetType()	現在のインスタンスの Type を取得します。 (継承元 Object)
Import(XmlSchemaSet)	XmlSchemaSet に含まれる指定した XML スキーマのセットを CodeCompileUnit に変換します。
Import(XmlSchemaSet, ICollection<XmlQualifiedName>)	XmlSchemaSet に含まれる指定したスキーマ型のセットを、CodeCompileUnit 内に生成される CLR 型に変換します。
Import(XmlSchemaSet, XmlQualifiedName)	XmlSchemaSet に含まれる指定した XML スキーマ型を CodeCompileUnit に変換します。
Import(XmlSchemaSet, XmlSchemaElement)	指定した XML スキーマのセット内の指定したスキーマ要素を CodeCompileUnit に変換し、指定した要素用のデータ コントラクト名を表す XmlQualifiedName を返します。
MemberwiseClone()	現在の Object の簡易コピーを作成します。 (継承元 Object)
ToString()	現在のオブジェクトを表す文字列を返します。 (継承元 Object)

こちらもご覧ください

• XsdDataContractExporter
• データ コントラクトの使用
• データ コントラクト シリアライザーでサポートされる型