DataMemberAttribute Sınıf

Tanım

Ad Alanı:

System.Runtime.Serialization

Bütünleştirilmiş Kod:

System.Runtime.Serialization.Primitives.dll

Kaynak:

DataMemberAttribute.cs

Bir türün üyesine uygulandığında, üyenin bir veri sözleşmesinin parçası olduğunu ve tarafından DataContractSerializerseri hale getirilebilir olduğunu belirtir.

public ref class DataMemberAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Property, AllowMultiple=false, Inherited=false)]
public sealed class DataMemberAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Property, AllowMultiple=false, Inherited=false)>]
type DataMemberAttribute = class
    inherit Attribute

Public NotInheritable Class DataMemberAttribute
Inherits Attribute

Devralma

Object

Attribute

DataMemberAttribute

Öznitelikler

AttributeUsageAttribute

Örnekler

Aşağıdaki örnekte ve DataMemberAttribute özniteliklerinin uygulandığı bir tür DataContractAttribute gösterilmektedir. Name üzerindeki DataMemberAttribute özelliği "Id" olarak ayarlanır.

using System;
using System.Collections;
using System.IO;
using System.Runtime.Serialization;
using System.Xml;

// You must apply a DataContractAttribute or SerializableAttribute
// to a class to have it serialized by the DataContractSerializer.
[DataContract()]
class Person : IExtensibleDataObject
{
    private string LastNameValue;
    // Apply the DataMemberAttribute to fields (or properties)
    // that must be serialized.
    [DataMember()]
    public string FirstName;

    [DataMember]
    public string LastName
    {
        get { return LastNameValue; }
        set { LastNameValue = value; }
    }

    [DataMember(Name = "ID")]
    public int IdNumber;

    // Note that you can apply the DataMemberAttribute to
    // a private field as well.
    [DataMember]
    private string Secret;

    public Person(string newfName, string newLName, int newIdNumber)
    {
        FirstName = newfName;
        LastName = newLName;
        IdNumber = newIdNumber;
        Secret = newfName + newLName + newIdNumber;
    }

    // The extensionDataValue field holds data from future versions
    // of the type.  This enables this type to be compatible with
    // future versions. The field is required to implement the
    // IExtensibleDataObject interface.

    private ExtensionDataObject extensionDatavalue;

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

public class Test
{
    public static void Main(string[] args)
    {
        try
        {
            WriteObject(@"DataMemberAttributeExample.xml");
            ReadObject(@"DataMemberAttributeExample.xml");
        }
        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)
    {
        // Create a new instance of the Person class.
        Person p1 = new Person("Zighetti", "Barbara", 101);
        FileStream writer = new FileStream(filename,
        FileMode.OpenOrCreate);
        DataContractSerializer ser =
            new DataContractSerializer(typeof(Person));
        ser.WriteObject(writer, p1);
        writer.Close();
    }

    public static void ReadObject(string filename)
    {
        // Deserialize an instance of the Person class
        // from an XML file.
        FileStream fs = new FileStream(filename,
        FileMode.OpenOrCreate);
        DataContractSerializer ser =
            new DataContractSerializer(typeof(Person));
        // Deserialize the data and read it from the instance.
        Person deserializedPerson = (Person)ser.ReadObject(fs);
        fs.Close();
        Console.WriteLine(String.Format("{0} {1}, ID: {2}",
        deserializedPerson.FirstName, deserializedPerson.LastName,
        deserializedPerson.IdNumber));
    }
}

Imports System.Collections
Imports System.IO
Imports System.Runtime.Serialization
Imports System.Xml

' You must apply a DataContractAttribute or SerializableAttribute
' to a class to have it serialized by the DataContractSerializer.
<DataContract()>  _
Class Person
    Implements IExtensibleDataObject

    Private LastNameValue As String
     
    ' Apply the DataMemberAttribute to fields (or properties) 
    ' that must be serialized.
    
    <DataMember()>  _
    Public FirstName As String
    
    <DataMember()>  _
    Public Property LastName() As String
        Get
            Return LastNameValue 
        End Get

        Set(ByVal Value As String)
           LastNameValue = Value
        End Set
    End Property

    
    <DataMember(Name:="ID")>  _
    Public IdNumber As Integer
    
    ' Note that you can apply the DataMemberAttribute to 
    ' a private field as well.
    <DataMember()>  _
    Private Secret As String
    
    Public Sub New(ByVal newfName As String, ByVal newLName As String, ByVal newIdNumber As Integer) 
        FirstName = newfName
        LastName = newLName
        IdNumber = newIdNumber
        Secret = newfName + newLName + newIdNumber.ToString()
    
    End Sub 
    
    ' The ExtensionData field holds data from future versions 
    ' of the type.  This enables this type to be compatible with 
    ' future versions. The field is required to implement the 
    ' IExtensibleObjectData interface.
    Private extensionDataValue As ExtensionDataObject
    
    Public Property ExtensionData() As ExtensionDataObject _
       Implements IExtensibleDataObject.ExtensionData
        Get
            Return extensionDataValue
        End Get
        Set
            extensionDataValue = value
        End Set
    End Property
End Class 

Public Class Test
    Public Shared Sub Main(ByVal args() As String) 
        Try
            ReadObject("DataMemberAttributeExample.xml")
            WriteObject("DataMemberAttributeExample.xml")
        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 ReadObject(ByVal filename As String) 
        ' Create a new instance of the Person class.
        Dim p1 As New Person("Zighetti", "Barbara", 101)
        Dim writer As New FileStream(filename, FileMode.Create)
        Dim ser As New DataContractSerializer(GetType(Person))
        ser.WriteObject(writer, p1)
        writer.Close()
    End Sub 

    Public Shared Sub WriteObject(ByVal filename As String) 
        ' Deserialize an instance of the Person class 
        ' from an XML file.
        Dim fs As New FileStream(filename, FileMode.OpenOrCreate)
        Dim ser As New DataContractSerializer(getTYpe(Person))
        ' Deserialize the data and read it from the instance.
        Dim deserializedPerson As Person = ser.ReadObject(fs)
        fs.Close()
        Console.WriteLine(String.Format("{0} {1}, ID: {2}", _
        deserializedPerson.FirstName, deserializedPerson.LastName, deserializedPerson.IdNumber))
    End Sub 
End Class

Açıklamalar

Bir veri sözleşmesinin DataMemberAttribute parçası olan bir türün üyelerini tanımlamak için özniteliğini ile DataContractAttribute birlikte uygulayın. Veri sözleşmelerini seri hale getirebilen serileştiricilerden biri de şeklindedir DataContractSerializer.

Veri sözleşmesi modeli bir "kabul etme" modelidir. DataMemberAttribute öğesinin bir alana veya özelliğe uygulanması, üye değerinin seri hale getirileceğini açıkça belirtir. Buna karşılık, türün XmlSerializer tüm ortak alanlarını ve özelliklerini serileştirir.

Dikkat

öğesini özel alanlara veya özelliklere uygulayabilirsiniz DataMemberAttribute . Üye tarafından döndürülen verilerin (özel olsa bile) seri hale getirileceğini ve seri durumdan çıkarılacağını ve bu nedenle kötü amaçlı bir kullanıcı veya işlem tarafından görüntülenebileceğini veya araya girilebileceğini unutmayın.

Varsayılan olarak, CLR üye adı veri üyesinin adı olarak kullanılır. özelliğini ayarlayarak Name veri üyesinin adını özelleştirebilirsiniz. Bu, CLR üye adı olarak izin verilmeyen bir ad sağlamak için kullanılabilir. kullanarak XML'ye DataContractSerializereşlendiğinde, bu ad bir türdeki şema öğesinin adı olarak kullanılır.

Not

Özniteliğin DataMemberAttribute uygulandığı özellikler hem hem de getset alanlarına sahip olmalıdır. Yalnızca veya set-only olamazlarget. Yalnızca tasarım gereği kalması getgereken bir özelliği seri hale getirmek için (örneğin, bir koleksiyon döndüren bir özellik), bunun yerine öğesini yedekleme alanına uygulamayı DataMemberAttribute göz önünde bulundurun.

Veri sözleşmeleri ve veri üyeleri hakkında daha fazla bilgi için bkz. Veri Sözleşmelerini Kullanma. Üye adları hakkında daha fazla bilgi için bkz. Veri Üyesi Varsayılan Değerleri.

Oluşturucular

DataMemberAttribute()

DataMemberAttribute sınıfının yeni bir örneğini başlatır.

Özellikler

EmitDefaultValue	Seri hale getirilen bir alan veya özellik için varsayılan değerin serileştirilip serileştirilmeyeceğini belirten bir değer alır veya ayarlar.
IsNameSetExplicitly	Açıkça ayarlanıp ayarlanmadığını Name alır.
IsRequired	Serileştirme altyapısına okuma veya seri durumdan çıkarma sırasında üyenin mevcut olması gerektiğini belirten bir değer alır veya ayarlar.
Name	Veri üyesi adını alır veya ayarlar.
Order	Bir üyenin seri hale getirme ve seri durumdan çıkarma sırasını alır veya ayarlar.
TypeId	Türetilmiş bir sınıfta uygulandığında, bu Attributeiçin benzersiz bir tanımlayıcı alır. (Devralındığı yer: Attribute)

Yöntemler

Equals(Object)	Bu örneğin belirtilen bir nesneye eşit olup olmadığını gösteren bir değeri döndürür. (Devralındığı yer: Attribute)
GetHashCode()	Bu örneğe ilişkin karma kodu döndürür. (Devralındığı yer: Attribute)
GetType()	Type Geçerli örneğini alır. (Devralındığı yer: Object)
IsDefaultAttribute()	Türetilmiş bir sınıfta geçersiz kılındığında, bu örneğin değerinin türetilmiş sınıf için varsayılan değer olup olmadığını gösterir. (Devralındığı yer: Attribute)
Match(Object)	Türetilmiş bir sınıfta geçersiz kılındığında, bu örneğin belirtilen bir nesneye eşit olup olmadığını gösteren bir değer döndürür. (Devralındığı yer: Attribute)
MemberwiseClone()	Geçerli Objectöğesinin sığ bir kopyasını oluşturur. (Devralındığı yer: Object)
ToString()	Geçerli nesneyi temsil eden dizeyi döndürür. (Devralındığı yer: Object)

Ayrıca bkz.

• DataContractAttribute
• DataContractSerializer
• IExtensibleDataObject
• Veri Sözleşmelerini Kullanma
• En İyi Yöntemler: Veri Sözleşmesi Sürümü Oluşturma
• Veri Üyesi Varsayılan Değerler
• Veri Üye Sırası