XsdDataContractExporter XsdDataContractExporter XsdDataContractExporter XsdDataContractExporter Class

定義

データ コントラクトで使用する .NET Framework 型のセットを XML スキーマ ファイル (.xsd) に変換できるようにします。Allows the transformation of a set of .NET Framework types that are used in data contracts into an XML schema file (.xsd).

public ref class XsdDataContractExporter
public class XsdDataContractExporter
type XsdDataContractExporter = class
Public Class XsdDataContractExporter
継承
XsdDataContractExporterXsdDataContractExporterXsdDataContractExporterXsdDataContractExporter

XsdDataContractExporter のインスタンスを作成し、Export(Type) メソッドを呼び出す例を次に示します。The following example creates an instance of the XsdDataContractExporter and calls the Export(Type) method.

using System;
using System.Xml;
using System.Runtime.Serialization;
using System.Xml.Schema;

public class Program
{
    public static void Main()
    {
        try
        {
            ExportXSD();
        }
        catch (Exception exc)
        {
            Console.WriteLine("Message: {0} StackTrace:{1}", exc.Message, exc.StackTrace);
        }
        finally
        {
            Console.ReadLine();
        }
    }

    static void ExportXSD()
    {
        XsdDataContractExporter exporter = new XsdDataContractExporter();
        if (exporter.CanExport(typeof(Employee)))
        {
            exporter.Export(typeof(Employee));
            Console.WriteLine("number of schemas: {0}", exporter.Schemas.Count);
            Console.WriteLine();
            XmlSchemaSet mySchemas = exporter.Schemas;

            XmlQualifiedName XmlNameValue = exporter.GetRootElementName(typeof(Employee));
            string EmployeeNameSpace = XmlNameValue.Namespace;

            foreach (XmlSchema schema in mySchemas.Schemas(EmployeeNameSpace))
            {
                schema.Write(Console.Out);
            }
        }
    }

    static void GetXmlElementName()
    {
        XsdDataContractExporter myExporter = new XsdDataContractExporter();
        XmlQualifiedName xmlElementName =myExporter.GetRootElementName(typeof(Employee));
        Console.WriteLine("Namespace: {0}", xmlElementName.Namespace);
        Console.WriteLine("Name: {0}", xmlElementName.Name);
        Console.WriteLine("IsEmpty: {0}", xmlElementName.IsEmpty);
    }

    [DataContract(Namespace = "www.Contoso.com/Examples/")]
    public class Employee
    {
        [DataMember]
        public string EmployeeName;
        [DataMember]
        private string ID;
    }
}
Imports System.Collections
Imports System.Xml
Imports System.Runtime.Serialization
Imports System.Xml.Schema

Public Class Program
    Public Shared Sub Main() 
        Try
            ExportXSD()
        Catch exc As Exception
            Console.WriteLine("Message: {0} StackTrace:{1}", exc.Message, exc.StackTrace)
        Finally
            Console.ReadLine()
        End Try
    
    End Sub 
    
    
    Shared Sub ExportXSD() 

        Dim exporter As New XsdDataContractExporter()

        ' Use the ExportOptions to add the Possessions type to the 
        ' collection of KnownTypes. 
        Dim eOptions As New ExportOptions()
        eOptions.KnownTypes.Add(GetType(Possessions))        
        exporter.Options = eOptions

        If exporter.CanExport(GetType(Employee)) Then
            exporter.Export(GetType(Employee))
            Console.WriteLine("number of schemas: {0}", exporter.Schemas.Count)
            Console.WriteLine()
            Dim mySchemas As XmlSchemaSet = exporter.Schemas
            
            Dim XmlNameValue As XmlQualifiedName = _
               exporter.GetRootElementName(GetType(Employee))
            Dim EmployeeNameSpace As String = XmlNameValue.Namespace
            
            Dim schema As XmlSchema
            For Each schema In  mySchemas.Schemas(EmployeeNameSpace)
                schema.Write(Console.Out)
            Next schema
        End If
    
    End Sub 
    
    
    Shared Sub GetXmlElementName() 
        Dim myExporter As New XsdDataContractExporter()
        Dim xmlElementName As XmlQualifiedName = myExporter. _
            GetRootElementName(GetType(Employee))
        Console.WriteLine("Namespace: {0}", xmlElementName.Namespace)
        Console.WriteLine("Name: {0}", xmlElementName.Name)
        Console.WriteLine("IsEmpty: {0}", xmlElementName.IsEmpty)
    
    End Sub 
    
    <DataContract([Namespace] := "www.Contoso.com/Examples/")>  _
    Public Class Employee

        <DataMember()>  _
        Public EmployeeName As String
        <DataMember()>  _
        Private ID As String
        ' This member may return a Possessions type.
        <DataMember> _
        public Miscellaneous As Hashtable 

    End Class 

    <DataContract> _
    Public Class Possessions

        <DataMember> _
        Public ItemName As String
    End Class

End Class

注釈

XsdDataContractExporter クラスは、共通言語ランタイム (CLR) 型で表されるデータを組み込む Web サービスを作成した場合、および他の Web サービスが消費できるように各型の XML スキーマをエクスポートする必要がある場合に使用します。Use the XsdDataContractExporter class when you have created a Web service that incorporates data represented by common language runtime (CLR) types and when you need to export XML schemas for each type to be consumed by other Web services. つまり、XsdDataContractExporter は、CLR 型のセットを XML スキーマに変換しますThat is, XsdDataContractExporter transforms a set of CLR types into XML schemas. (使用できる型の詳細については、「データコントラクトシリアライザーでサポートされる型」を参照してください)。変換した後、Web サービス記述言語 (WSDL) ドキュメントを通じてスキーマを公開することで、作成されたサービスと相互運用する必要がある他の Web サービスで使用することができます。(For more information about the types that can be used, see Types Supported by the Data Contract Serializer.) The schemas can then be exposed through a Web Services Description Language (WSDL) document for use by others who need to interoperate with your service.

逆に、既存の Web サービスを組み込む必要がある Web サービスを作成する場合は、XsdDataContractImporter を使用して XML スキーマを変換し、選択したプログラミング言語でデータを表す CLR 型を作成します。Conversely, if you are creating a Web service that must interoperate with an existing Web service, use the XsdDataContractImporter to transform XML schemas and create the CLR types that represent the data in a selected programming language.

XsdDataContractExporter は、スキーマのコレクションを含む XmlSchemaSet オブジェクトを生成します。The XsdDataContractExporter generates an XmlSchemaSet object that contains the collection of schemas. スキーマのセットには Schemas プロパティを通じてアクセスします。Access the set of schemas through the Schemas property.

注意

他の Web サービスが消費できる XML スキーマ定義 (XSD) ファイルをすばやく生成するには、XsdDataContractExporter を使用します。To quickly generate XML schema definition (XSD) files that other Web services can consume, use the XsdDataContractExporter.

XmlSchemaSet へのスキーマのエクスポートExporting Schemas Into an XmlSchemaSet

XML スキーマ ファイルを含む XmlSchemaSet クラスのインスタンスを作成する際は、次の事項に注意します。To create an instance of the XmlSchemaSet class that contains XML schema files, you should be aware of the following.

エクスポートする型のセットは、データ コントラクトの内部セットとして記録されます。The set of types you are exporting are recorded as an internal set of data contracts. したがって、CanExport メソッドを複数回呼び出して、スキーマ セットに新しい型を追加できます。このとき、新しい型だけがセットに追加されるので、パフォーマンスが低下することはありません。Thus, you can call the CanExport method multiple times to add new types to the schema set without degrading performance because only the new types will be added to the set. Export 操作中に、既存のスキーマが、追加される新しいスキーマと比較されます。During the Export operation, the existing schemas are compared to the new schemas being added. 競合が発生した場合は、例外がスローされます。If there are conflicts, an exception will be thrown. 通常、競合は、データ コントラクトの名前は同じだが、コントラクトが異なる (メンバーが異なる) 2 つの型が、同一の XsdDataContractExporter インスタンスによってエクスポートされた場合に検出されます。A conflict is usually detected if two types with the same data contract name but different contracts (different members) are exported by the same XsdDataContractExporter instance.

エクスポーターの使用Using the Exporter

このクラスを使用する際の推奨方法を次に示します。A recommended way of using this class is as follows:

  1. いずれかの CanExport オーバーロードを使用して、指定した型または型のセットがエクスポート可能かどうかを決定します。Use one of the CanExport overloads to determine whether the specified type or set of types can be exported. 各自の要件に適したいずれかのオーバーロードを使用します。Use one of the overloads that is appropriate to your requirements.

  2. 対応する Export メソッドを呼び出します。Call the corresponding Export method.

  3. Schemas プロパティからスキーマを取得します。Retrieve the schemas from the Schemas property.

コンストラクター

XsdDataContractExporter() XsdDataContractExporter() XsdDataContractExporter() XsdDataContractExporter()

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

XsdDataContractExporter(XmlSchemaSet) XsdDataContractExporter(XmlSchemaSet) XsdDataContractExporter(XmlSchemaSet) XsdDataContractExporter(XmlSchemaSet)

スキーマのセットを指定して、XsdDataContractExporter クラスの新しいインスタンスを初期化します。Initializes a new instance of the XsdDataContractExporter class with the specified set of schemas.

プロパティ

Options Options Options Options

エクスポート操作に対して設定できるオプションを含む ExportOptions を取得または設定します。Gets or sets an ExportOptions that contains options that can be set for the export operation.

Schemas Schemas Schemas Schemas

エクスポートされた XML スキーマのコレクションを取得します。Gets the collection of exported XML schemas.

メソッド

CanExport(ICollection<Assembly>) CanExport(ICollection<Assembly>) CanExport(ICollection<Assembly>) CanExport(ICollection<Assembly>)

アセンブリのセットに含まれている共通言語ランタイム (CLR) 型がエクスポート可能かどうかどうかを示す値を取得します。Gets a value that indicates whether the set of .common language runtime (CLR) types contained in a set of assemblies can be exported.

CanExport(ICollection<Type>) CanExport(ICollection<Type>) CanExport(ICollection<Type>) CanExport(ICollection<Type>)

ICollection<T> に含まれる共通言語ランタイム (CLR) 型がエクスポート可能かどうかどうかを示す値を取得します。Gets a value that indicates whether the set of .common language runtime (CLR) types contained in a ICollection<T> can be exported.

CanExport(Type) CanExport(Type) CanExport(Type) CanExport(Type)

指定した共通言語ランタイム (CLR) 型がエクスポート可能かどうかどうかを示す値を取得します。Gets a value that indicates whether the specified common language runtime (CLR) type can be exported.

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

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

(Inherited from Object)
Export(ICollection<Assembly>) Export(ICollection<Assembly>) Export(ICollection<Assembly>) Export(ICollection<Assembly>)

指定したアセンブリのコレクションに含まれる型を変換します。Transforms the types contained in the specified collection of assemblies.

Export(ICollection<Type>) Export(ICollection<Type>) Export(ICollection<Type>) Export(ICollection<Type>)

このメソッドに渡された ICollection<T> に含まれた型を変換します。Transforms the types contained in the ICollection<T> passed to this method.

Export(Type) Export(Type) Export(Type) Export(Type)

指定した .NET Framework.NET Framework 型を XML スキーマ定義言語 (XSD) のスキーマに変換します。Transforms the specified .NET Framework.NET Framework type into an XML schema definition language (XSD) schema.

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

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

(Inherited from Object)
GetRootElementName(Type) GetRootElementName(Type) GetRootElementName(Type) GetRootElementName(Type)

Type のトップレベル名と名前空間を返します。Returns the top-level name and namespace for the Type.

GetSchemaType(Type) GetSchemaType(Type) GetSchemaType(Type) GetSchemaType(Type)

指定した型の XML スキーマの型を返します。Returns the XML schema type for the specified type.

GetSchemaTypeName(Type) GetSchemaTypeName(Type) GetSchemaTypeName(Type) GetSchemaTypeName(Type)

Type のコントラクト名とコントラクト名前空間を返します。Returns the contract name and contract namespace for the Type.

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

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

(Inherited from Object)
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)

適用対象

こちらもご覧ください