NetDataContractSerializer Class

定義

指定した .NET Framework 型を使用して、型のインスタンスを XML ストリームまたはドキュメントにシリアル化および逆シリアル化します。 Serializes and deserializes an instance of a type into XML stream or document using the supplied .NET Framework types. このクラスは継承できません。 This class cannot be inherited.

public sealed class NetDataContractSerializer : System.Runtime.Serialization.XmlObjectSerializer, System.Runtime.Serialization.IFormatter
継承
NetDataContractSerializer
実装

次のコード例は、Person によってシリアル化される NetDataContractSerializer という名前の型を示しています。The following example code shows a type named Person that is serialized by the NetDataContractSerializer. DataContractAttribute 属性がクラスに適用され、DataMemberAttribute がメンバー (プライベート メンバーを含みます) に適用され、シリアル化の対象を NetDataContractSerializer に指示します。The DataContractAttribute attribute is applied to the class, and the DataMemberAttribute is applied to members (including a private member) to instruct the NetDataContractSerializer what to serialize.

// You must apply a DataContractAttribute or SerializableAttribute
// to a class to have it serialized by the NetDataContractSerializer.
[DataContract(Name = "Customer", Namespace = "http://www.contoso.com")]
class Person : IExtensibleDataObject
{
    [DataMember()]
    public string FirstName;
    [DataMember]
    public string LastName;
    [DataMember()]
    public int ID;

    public Person(string newfName, string newLName, int newID)
    {
        FirstName = newfName;
        LastName = newLName;
        ID = newID;
    }

    private ExtensionDataObject extensionData_Value;

    public ExtensionDataObject ExtensionData
    {
        get
        {
            return extensionData_Value;
        }
        set
        {
            extensionData_Value = value;
        }
    }
}

public sealed class Test
{
    private Test() { }

    public static void Main()
    {
        try
        {
            WriteObject("NetDataContractSerializerExample.xml");
            ReadObject("NetDataContractSerializerExample.xml");
        }

        catch (SerializationException serExc)
        {
            Console.WriteLine("Serialization Failed");
            Console.WriteLine(serExc.Message);
        }
        catch (Exception exc)
        {
            Console.WriteLine(
            "The serialization operation failed: {0} StackTrace: {1}",
            exc.Message, exc.StackTrace);
        }

        finally
        {
            Console.WriteLine("Press <Enter> to exit....");
            Console.ReadLine();
        }
    }

    public static void WriteObject(string fileName)
    {
        Console.WriteLine(
            "Creating a Person object and serializing it.");
        Person p1 = new Person("Zighetti", "Barbara", 101);
        FileStream fs = new FileStream(fileName, FileMode.Create);
        XmlDictionaryWriter writer = XmlDictionaryWriter.CreateTextWriter(fs);
        NetDataContractSerializer ser =
            new NetDataContractSerializer();
        ser.WriteObject(writer, p1);
        writer.Close();
    }

    public static void ReadObject(string fileName)
    {
        Console.WriteLine("Deserializing an instance of the object.");
        FileStream fs = new FileStream(fileName,
        FileMode.Open);
        XmlDictionaryReader reader =
            XmlDictionaryReader.CreateTextReader(fs, new XmlDictionaryReaderQuotas());
        NetDataContractSerializer ser = new NetDataContractSerializer();

        // Deserialize the data and read it from the instance.
        Person deserializedPerson =
            (Person)ser.ReadObject(reader, true);
        fs.Close();
        Console.WriteLine(String.Format("{0} {1}, ID: {2}",
        deserializedPerson.FirstName, deserializedPerson.LastName,
        deserializedPerson.ID));
    }
}
' You must apply a DataContractAttribute or SerializableAttribute
' to a class to have it serialized by the NetDataContractSerializer.
<DataContract(Name := "Customer", [Namespace] := "http://www.contoso.com")>  _
Class Person
    Implements IExtensibleDataObject
    <DataMember()>  _
    Public FirstName As String
    <DataMember()>  _
    Public LastName As String
    <DataMember()>  _
    Public ID As Integer
    
    
    Public Sub New(ByVal newfName As String, ByVal newLName As String, _
       ByVal newID As Integer) 
        FirstName = newfName
        LastName = newLName
        ID = newID
    
    End Sub 
    
    Private extensionData_Value As ExtensionDataObject
    
    
    Public Property ExtensionData() As ExtensionDataObject _
     Implements IExtensibleDataObject.ExtensionData
        Get
            Return extensionData_Value
        End Get
        Set
            extensionData_Value = value
        End Set
    End Property
End Class 


NotInheritable Public Class Test

    Private Sub New() 
    
    End Sub
     
    Public Shared Sub Main() 
        Try
            WriteObject("NetDataContractSerializerExample.xml")
            ReadObject("NetDataContractSerializerExample.xml")
        
        Catch serExc As SerializationException
            Console.WriteLine("Serialization Failed")
            Console.WriteLine(serExc.Message)
        Catch exc As Exception
            Console.WriteLine("The serialization operation failed: {0} StackTrace: {1}", exc.Message, exc.StackTrace)
        
        Finally
            Console.WriteLine("Press <Enter> to exit....")
            Console.ReadLine()
        End Try
    
    End Sub 
    
    
    Public Shared Sub WriteObject(ByVal fileName As String) 
        Console.WriteLine("Creating a Person object and serializing it.")
        Dim p1 As New Person("Zighetti", "Barbara", 101)
        Dim fs As New FileStream(fileName, FileMode.Create)
        Dim writer As XmlDictionaryWriter = XmlDictionaryWriter.CreateTextWriter(fs)
        Dim ser As New System.Runtime.Serialization.NetDataContractSerializer()

        ser.WriteObject(writer, p1)
        writer.Close()
    
    End Sub     

    Public Shared Sub ReadObject(ByVal fileName As String) 
        Console.WriteLine("Deserializing an instance of the object.")
        Dim fs As New FileStream(fileName, FileMode.Open)
        Dim reader As XmlDictionaryReader = _
           XmlDictionaryReader.CreateTextReader(fs, New XmlDictionaryReaderQuotas())
        Dim ser As New System.Runtime.Serialization.NetDataContractSerializer()
        
        ' Deserialize the data and read it from the instance.
        Dim deserializedPerson As Person = CType(ser.ReadObject(reader, True), Person)
        fs.Close()
        Console.WriteLine(String.Format("{0} {1}, ID: {2}", deserializedPerson.FirstName, deserializedPerson.LastName, deserializedPerson.ID))
    
    End Sub 
End Class 

注釈

NetDataContractSerializer は、1 つの重要な点で DataContractSerializer とは異なります。NetDataContractSerializer はシリアル化された XML の中に CLR 型情報を含みますが、DataContractSerializer にはこの情報は含まれません。The NetDataContractSerializer differs from the DataContractSerializer in one important way: the NetDataContractSerializer includes CLR type information in the serialized XML, whereas the DataContractSerializer does not. したがって、NetDataContractSerializer は、シリアル化と逆シリアル化の両方で、同一の CLR 型を共有する結果になる場合のみ使用できます。Therefore, the NetDataContractSerializer can be used only if both the serializing and deserializing ends share the same CLR types.

シリアライザーは、DataContractAttribute 属性または SerializableAttribute 属性のいずれかが適用されている型をシリアル化できます。The serializer can serialize types to which either the DataContractAttribute or SerializableAttribute attribute has been applied. また、ISerializable を実装する型をシリアル化します。It also serializes types that implement ISerializable.

シリアル化の詳細については、次を参照してください。シリアル化および逆シリアル化します。For more information about serialization, see Serialization and Deserialization.

XElement との互換性がないIncompatibility with XElement

XElement クラスは XML の記述に使用されます。The XElement class is used to write XML. ただし、NetDataContractSerializer はこの型のインスタンスをシリアル化できません。However, the NetDataContractSerializer cannot serialize an instance of the type. 次のコードでは、そのため、例外で失敗します"ルート型 'system.xml.linq.xelement' は IXmlSerializable であるためには NetDataContractSerializer で最上位レベルでサポートされませんIsAny = trueし、すべてを記述する必要があります。要素を含むコンテンツのルートです。"The following code, therefore, fails with the exception: "Root type 'System.Xml.Linq.XElement' is not supported at the top level by NetDataContractSerializer since it is IXmlSerializable with IsAny=true and must write all its contents including the root element."

FileStream fs = new FileStream("mystuff.xml", FileMode.Create, FileAccess.ReadWrite);
XElement myElement = new XElement("Parent", new XElement("child1", "form"),
    new XElement("child2", "base"),
    new XElement("child3", "formbase")
    );
NetDataContractSerializer dcs = new NetDataContractSerializer();
dcs.WriteObject(fs, myElement);
Dim fs As New FileStream("mystuff.xml", FileMode.Create, FileAccess.ReadWrite)
Dim myElement As New XElement("Parent", New XElement("child1", "form"), _
    New XElement("child2", "base"), _
    New XElement("child3", "formbase") _
    )
Dim ser As New System.Runtime.Serialization. _
  NetDataContractSerializer()
ser.WriteObject(fs, myElement)

ただし、XElement をフィールドの型またはクラスのプロパティとして使用する場合、フィールドまたはプロパティに含まれるデータはシリアル化されます。However, if an XElement is used as the type of a field or property of a class, the data contained by the field or property is serialized. これは、クラスのメンバーとして、データはクラスのトップ レベルではないからです。This is because as a member of a class, the data is not the top level of the class.

コンストラクター

NetDataContractSerializer()

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

NetDataContractSerializer(StreamingContext)

指定したストリーミング コンテキスト データを使用して、NetDataContractSerializer クラスの新しいインスタンスを初期化します。 Initializes a new instance of the NetDataContractSerializer class with the supplied streaming context data.

NetDataContractSerializer(StreamingContext, Int32, Boolean, FormatterAssemblyStyle, ISurrogateSelector)

コンテキスト データ、シリアル化されるオブジェクト内の項目の最大数、追加データを無視するかどうかを指定するパラメーター、アセンブリを読み込むメソッドを指定するパラメーター、サロゲート セレクターを指定するパラメーターを使用して、NetDataContractSerializer クラスの新しいインスタンスを初期化します。 Initializes a new instance of the NetDataContractSerializer class with the supplied context data; in addition, specifies the maximum number of items in the object to be serialized, and parameters to specify whether extra data is ignored, the assembly loading method, and a surrogate selector.

NetDataContractSerializer(String, String)

指定した XML ルート要素と名前空間を指定して、NetDataContractSerializer クラスの新しいインスタンスを初期化します。 Initializes a new instance of the NetDataContractSerializer class with the supplied XML root element and namespace.

NetDataContractSerializer(String, String, StreamingContext, Int32, Boolean, FormatterAssemblyStyle, ISurrogateSelector)

コンテキスト データ、ルート名、シリアル化されるオブジェクト内の項目の最大数、追加データを無視するかどうかを指定するパラメーター、アセンブリを読み込むメソッドを指定するパラメーター、およびサロゲート セレクターを指定するパラメーターを使用して、NetDataContractSerializer クラスの新しいインスタンスを初期化します。 Initializes a new instance of the NetDataContractSerializer class with the supplied context data and root name and namespace; in addition, specifies the maximum number of items in the object to be serialized, and parameters to specify whether extra data is ignored, the assembly loading method, and a surrogate selector.

NetDataContractSerializer(XmlDictionaryString, XmlDictionaryString)

コンテンツを指定するために使用されるルート要素と名前空間を含む NetDataContractSerializer 型の 2 つのパラメーターを使用して、XmlDictionaryString クラスの新しいインスタンスを初期化します。 Initializes a new instance of the NetDataContractSerializer class with two parameters of type XmlDictionaryString that contain the root element and namespace used to specify the content.

NetDataContractSerializer(XmlDictionaryString, XmlDictionaryString, StreamingContext, Int32, Boolean, FormatterAssemblyStyle, ISurrogateSelector)

コンテキスト データ、ルート名、名前空間 (XmlDictionaryString パラメーターとして指定)、シリアル化されるオブジェクト内の項目の最大数、追加データを無視するかどうかを指定するパラメーター、アセンブリを読み込むメソッドを指定するパラメーター、サロゲート セレクターを指定するパラメーターを使用して、NetDataContractSerializer クラスの新しいインスタンスを初期化します。 Initializes a new instance of the NetDataContractSerializer class with the supplied context data, and root name and namespace (as XmlDictionaryString parameters); in addition, specifies the maximum number of items in the object to be serialized, and parameters to specify whether extra data found is ignored, assembly loading method, and a surrogate selector.

プロパティ

AssemblyFormat

アセンブリの検索および読み込みをするメソッドを指定する値を取得します。 Gets a value that specifies a method for locating and loading assemblies.

Binder

クラスの読み込みを制御するオブジェクトを取得または設定します。 Gets or sets an object that controls class loading.

Context

シリアル化または逆シリアル化するときに役に立つコンテキスト データを渡すことを可能にするオブジェクトを取得または設定します。 Gets or sets the object that enables the passing of context data that is useful while serializing or deserializing.

IgnoreExtensionDataObject

オブジェクトの拡張機能により提供されるデータを無視するかどうかを指定する値を取得します。 Gets a value that specifies whether data supplied by an extension of the object is ignored.

MaxItemsInObjectGraph

シリアル化されるオブジェクトで許可される項目の最大数を取得します。 Gets the maximum number of items allowed in the object to be serialized.

SurrogateSelector

シリアル化のサロゲートを選択するときにフォーマッタを支援するオブジェクトを取得または設定します。 Gets or sets an object that assists the formatter when selecting a surrogate for serialization.

方法

Deserialize(Stream)

XML ドキュメントまたはストリームをオブジェクトに逆シリアル化します。 Deserializes an XML document or stream into an object.

Equals(Object)

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

(Inherited from Object)
GetHashCode()

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

(Inherited from Object)
GetType()

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

(Inherited from Object)
IsStartObject(XmlDictionaryReader)

指定したリーダーを使用して逆シリアル化できるオブジェクトに XmlDictionaryReader が配置されているかどうかを決定します。 Determines whether the XmlDictionaryReader is positioned on an object that can be deserialized using the specified reader.

IsStartObject(XmlReader)

指定したリーダーを使用して逆シリアル化できるオブジェクトに XmlReader が配置されているかどうかを決定します。 Determines whether the XmlReader is positioned on an object that can be deserialized using the specified reader.

MemberwiseClone()

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

(Inherited from Object)
ReadObject(Stream)

Stream を使用して XML ストリームまたはドキュメントを読み取り、逆シリアル化されたオブジェクトを返します。 Reads the XML stream or document with a Stream and returns the deserialized object.

(Inherited from XmlObjectSerializer)
ReadObject(XmlDictionaryReader)

XmlDictionaryReader を使用して XML ドキュメントまたはストリームを読み取り、逆シリアル化されたオブジェクトを返します。 Reads the XML document or stream with an XmlDictionaryReader and returns the deserialized object.

(Inherited from XmlObjectSerializer)
ReadObject(XmlDictionaryReader, Boolean)

XmlDictionaryReader を使用して XML ストリームまたはドキュメントを読み取ります。オブジェクトのデータが、シリアライザーを作成するために使用された名前および名前空間と一致するかどうかもチェックされます。 Reads the XML stream or document with an XmlDictionaryReader and returns the deserialized object; also checks whether the object data conforms to the name and namespace used to create the serializer.

ReadObject(XmlReader)

XmlDictionaryReader を使用して XML ストリームまたはドキュメントを読み取り、逆シリアル化されたオブジェクトを返します。 Reads the XML stream or document with an XmlDictionaryReader and returns the deserialized object.

ReadObject(XmlReader, Boolean)

XmlDictionaryReader を使用して XML ストリームまたはドキュメントを読み取ります。オブジェクトのデータが、シリアライザーを作成するために使用された名前および名前空間と一致するかどうかもチェックされます。 Reads the XML stream or document with an XmlDictionaryReader and returns the deserialized object; also checks whether the object data conforms to the name and namespace used to create the serializer.

Serialize(Stream, Object)

指定したライターを使用して、指定したオブジェクトをシリアル化します。 Serializes the specified object graph using the specified writer.

ToString()

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

(Inherited from Object)
WriteEndObject(XmlDictionaryWriter)

XmlDictionaryWriter を使用して、XML の終了要素を書き込みます。 Writes the closing XML element using an XmlDictionaryWriter.

WriteEndObject(XmlWriter)

XmlWriter を使用して、XML の終了要素を書き込みます。 Writes the closing XML element using an XmlWriter.

WriteObject(Stream, Object)

Stream を使用して、オブジェクトの完全なコンテンツ (開始、コンテンツ、および終了) を XML ドキュメントまたはストリームに書き込みます。 Writes the complete content (start, content, and end) of the object to the XML document or stream with the specified Stream.

(Inherited from XmlObjectSerializer)
WriteObject(XmlDictionaryWriter, Object)

XmlDictionaryWriter を使用して、オブジェクトの完全なコンテンツ (開始、コンテンツ、および終了) を XML ドキュメントまたはストリームに書き込みます。 Writes the complete content (start, content, and end) of the object to the XML document or stream with the specified XmlDictionaryWriter.

(Inherited from XmlObjectSerializer)
WriteObject(XmlWriter, Object)

XmlWriter を使用して、オブジェクトの完全なコンテンツ (開始、コンテンツ、および終了) を XML ドキュメントまたはストリームに書き込みます。 Writes the complete content (start, content, and end) of the object to the XML document or stream with the specified XmlWriter.

WriteObjectContent(XmlDictionaryWriter, Object)

XmlDictionaryWriter を使用して、XML コンテンツを書き込みます。 Writes the XML content using an XmlDictionaryWriter.

WriteObjectContent(XmlWriter, Object)

XmlWriter を使用して、XML コンテンツを書き込みます。 Writes the XML content using an XmlWriter.

WriteStartObject(XmlDictionaryWriter, Object)

XmlDictionaryWriter を使用して、XML の開始要素を書き込みます。 Writes the opening XML element using an XmlDictionaryWriter.

WriteStartObject(XmlWriter, Object)

XmlWriter を使用して、XML の開始要素を書き込みます。 Writes the opening XML element using an XmlWriter.

適用対象

こちらもご覧ください