XsdDataContractImporter XsdDataContractImporter XsdDataContractImporter XsdDataContractImporter Class

定義

XML スキーマ ファイル (.xsd) のセットを共通言語ランタイム (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
継承
XsdDataContractImporterXsdDataContractImporterXsdDataContractImporterXsdDataContractImporter

XmlSchemaSet を作成し、Import メソッドを呼び出して CodeCompileUnit を作成する例を次に示します。The following example creates an XmlSchemaSet and calls the Import method to create a CodeCompileUnit. その後、CodeCompileUnit を使用して Visual C# コード ファイルと 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 

注釈

既存の Web サービスを組み込む必要がある Web サービス、または XML スキーマからデータ コントラクト型を作成する場合は、XsdDataContractImporter を使用します。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 は、XML スキーマのセットを変換し、選択したプログラミング言語でデータ コントラクトを表す .NET Framework.NET Framework 型を作成します。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. コードを作成するには、System.CodeDom 名前空間を使用します。To create the code, use the classes in the System.CodeDom namespace.

逆に、CLR 型で表されるデータを組み込む Web サービスを作成する場合、および他の Web サービスが消費できるように各データ型の XML スキーマをエクスポートする必要がある場合は、XsdDataContractExporter クラスを使用します。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. つまり、XsdDataContractExporter は、CLR 型のセットを XML スキーマのセットに変換します。That is, XsdDataContractExporter transforms a set of CLR types into a set of XML schemas.

注意

デザイン時に XML スキーマから CLR 型を生成するには、 ServiceModel メタデータユーティリティツール (svcutil.exe)を使用します。To generate CLR types from XML schemas at design time, use the ServiceModel Metadata Utility Tool (Svcutil.exe). XSD ファイルからコードを生成するには/dataContractOnly 、ツールのスイッチを使用します。To generated code from XSD files, use the /dataContractOnly switch of the tool. この処理をさらに制御する必要がある、またはプログラムによって実行する必要がある場合は、XsdDataContractImporter を使用することもできます。You can also use the XsdDataContractImporter if you need more control over the process or need to do it programmatically.

コンストラクター

XsdDataContractImporter() XsdDataContractImporter() XsdDataContractImporter() XsdDataContractImporter()

XsdDataContractImporter クラスの新しいインスタンスを初期化します。Initializes a new instance of the XsdDataContractImporter class.

XsdDataContractImporter(CodeCompileUnit) XsdDataContractImporter(CodeCompileUnit) XsdDataContractImporter(CodeCompileUnit) XsdDataContractImporter(CodeCompileUnit)

CLR コードを生成するために使用される XsdDataContractImporter を使用して、CodeCompileUnit クラスの新しいインスタンスを初期化します。Initializes a new instance of the XsdDataContractImporter class with the CodeCompileUnit that will be used to generate CLR code.

プロパティ

CodeCompileUnit CodeCompileUnit CodeCompileUnit CodeCompileUnit

生成された CLR 型を格納するために使用される CodeCompileUnit を取得します。Gets a CodeCompileUnit used for storing the CLR types generated.

Options Options Options Options

インポート操作で設定可能なオプションを含む ImportOptions を取得または設定します。Gets or sets an ImportOptions that contains settable options for the import operation.

メソッド

CanImport(XmlSchemaSet) CanImport(XmlSchemaSet) CanImport(XmlSchemaSet) CanImport(XmlSchemaSet)

XmlSchemaSet に含まれているスキーマを CodeCompileUnit に変換できるかどうかを示す値を取得します。Gets a value that indicates whether the schemas contained in an XmlSchemaSet can be transformed into a CodeCompileUnit.

CanImport(XmlSchemaSet, ICollection<XmlQualifiedName>) CanImport(XmlSchemaSet, ICollection<XmlQualifiedName>) CanImport(XmlSchemaSet, ICollection<XmlQualifiedName>) CanImport(XmlSchemaSet, ICollection<XmlQualifiedName>)

XmlSchemaSet に含まれる指定した型のセットが、CodeCompileUnit 内に生成される CLR 型に変換できるかどうかを示す値を取得します。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) CanImport(XmlSchemaSet, XmlQualifiedName) CanImport(XmlSchemaSet, XmlQualifiedName) CanImport(XmlSchemaSet, XmlQualifiedName)

XmlSchemaSet に含まれているスキーマを CodeCompileUnit に変換できるかどうかを示す値を取得します。Gets a value that indicates whether the schemas contained in an XmlSchemaSet can be transformed into a CodeCompileUnit.

CanImport(XmlSchemaSet, XmlSchemaElement) CanImport(XmlSchemaSet, XmlSchemaElement) CanImport(XmlSchemaSet, XmlSchemaElement) CanImport(XmlSchemaSet, XmlSchemaElement)

XmlSchemaSet に含まれる指定したスキーマ要素をインポートできるかどうかを示す値を取得します。Gets a value that indicates whether a specific schema element contained in an XmlSchemaSet can be imported.

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

指定したオブジェクトが、現在のオブジェクトと等しいかどうかを判断します。Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetCodeTypeReference(XmlQualifiedName) GetCodeTypeReference(XmlQualifiedName) GetCodeTypeReference(XmlQualifiedName) GetCodeTypeReference(XmlQualifiedName)

指定した CodeTypeReference を持つスキーマ型に対して生成された CLR 型への XmlQualifiedName を返します。Returns a CodeTypeReference to the CLR type generated for the schema type with the specified XmlQualifiedName.

GetCodeTypeReference(XmlQualifiedName, XmlSchemaElement) GetCodeTypeReference(XmlQualifiedName, XmlSchemaElement) GetCodeTypeReference(XmlQualifiedName, XmlSchemaElement) GetCodeTypeReference(XmlQualifiedName, XmlSchemaElement)

指定した XML 修飾要素とスキーマ要素の CodeTypeReference を返します。Returns a CodeTypeReference for the specified XML qualified element and schema element.

GetHashCode() GetHashCode() GetHashCode() GetHashCode()

既定のハッシュ関数として機能します。Serves as the default hash function.

(Inherited from Object)
GetKnownTypeReferences(XmlQualifiedName) GetKnownTypeReferences(XmlQualifiedName) GetKnownTypeReferences(XmlQualifiedName) GetKnownTypeReferences(XmlQualifiedName)

指定したスキーマ型のコードを生成するときに生成される既知の型を表す CodeTypeReference オブジェクトのリストを返します。Returns a list of CodeTypeReference objects that represents the known types generated when generating code for the specified schema type.

GetType() GetType() GetType() GetType()

現在のインスタンスの Type を取得します。Gets the Type of the current instance.

(Inherited from Object)
Import(XmlSchemaSet) Import(XmlSchemaSet) Import(XmlSchemaSet) Import(XmlSchemaSet)

XmlSchemaSet に含まれる指定した XML スキーマのセットを CodeCompileUnit に変換します。Transforms the specified set of XML schemas contained in an XmlSchemaSet into a CodeCompileUnit.

Import(XmlSchemaSet, ICollection<XmlQualifiedName>) Import(XmlSchemaSet, ICollection<XmlQualifiedName>) Import(XmlSchemaSet, ICollection<XmlQualifiedName>) Import(XmlSchemaSet, ICollection<XmlQualifiedName>)

XmlSchemaSet に含まれる指定したスキーマ型のセットを、CodeCompileUnit 内に生成される CLR 型に変換します。Transforms the specified set of schema types contained in an XmlSchemaSet into CLR types generated into a CodeCompileUnit.

Import(XmlSchemaSet, XmlQualifiedName) Import(XmlSchemaSet, XmlQualifiedName) Import(XmlSchemaSet, XmlQualifiedName) Import(XmlSchemaSet, XmlQualifiedName)

XmlSchemaSet に含まれる指定した XML スキーマ型を CodeCompileUnit に変換します。Transforms the specified XML schema type contained in an XmlSchemaSet into a CodeCompileUnit.

Import(XmlSchemaSet, XmlSchemaElement) Import(XmlSchemaSet, XmlSchemaElement) Import(XmlSchemaSet, XmlSchemaElement) Import(XmlSchemaSet, XmlSchemaElement)

指定した XML スキーマのセット内の指定したスキーマ要素を CodeCompileUnit に変換し、指定した要素用のデータ コントラクト名を表す XmlQualifiedName を返します。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() MemberwiseClone() MemberwiseClone() MemberwiseClone()

現在の Object の簡易コピーを作成します。Creates a shallow copy of the current Object.

(Inherited from Object)
ToString() ToString() ToString() ToString()

現在のオブジェクトを表す文字列を返します。Returns a string that represents the current object.

(Inherited from Object)

適用対象

こちらもご覧ください