DataMemberAttribute Classe

Definizione

Spazio dei nomi:

System.Runtime.Serialization

Assembly:

netstandard.dll, System.Runtime.Serialization.Primitives.dll

Origine:

DataMemberAttribute.cs

Quando viene applicato al membro di un tipo, specifica che il membro fa parte di un contratto dati e può essere serializzato dalla classe DataContractSerializer.

C#

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

Ereditarietà

Object

Attribute

DataMemberAttribute

Attributi

AttributeUsageAttribute

Esempio

Nell'esempio seguente viene illustrato un tipo a cui sono stati applicati gli DataContractAttribute attributi e DataMemberAttribute . La Name proprietà in DataMemberAttribute è impostata su "ID".

C#

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));
    }
}

Commenti

Applicare l'attributo DataMemberAttribute insieme all'attributo DataContractAttribute per identificare membri di un tipo che fanno parte di un contratto dati. Uno dei serializzatori che possono serializzare contratti dati è DataContractSerializer.

Il modello del contratto dati è un modello di "consenso esplicito". L'applicazione di DataMemberAttribute a un campo o proprietà specifica in modo esplicito che il valore del membro verrà serializzato. Al contrario, XmlSerializer serializza tutti i campi pubblici e le proprietà di un tipo.

Attenzione

È possibile applicare DataMemberAttribute a campi o proprietà private. Tenere presente che i dati restituiti dal membro (anche se sono privati) verranno serializzati e deserializzati e quindi possono essere visualizzati o intercettati da un utente o da un processo dannoso.

Per impostazione predefinita, il nome del membro CLR viene utilizzato come nome del membro dati. Se si imposta la proprietà Name è possibile personalizzare il nome del membro dati. Può essere utilizzato per fornire un nome che può non essere consentito come nome di membro CLR. Quando si esegue il mapping a XML utilizzando DataContractSerializer, questo nome viene utilizzato come nome dell'elemento dello schema in un tipo.

Nota

Le proprietà a cui è stato applicato l'attributo DataMemberAttribute devono avere entrambi get i campi e set . Non possono essere get-only o set-only. Per serializzare una proprietà che deve rimanere getsolo per impostazione predefinita , ad esempio una proprietà che restituisce un insieme, è consigliabile applicare al DataMemberAttribute campo sottostante.

Per altre informazioni sui contratti dati e sui membri dati, vedere Uso dei contratti dati. Per altre informazioni sui nomi dei membri, vedere Valori predefiniti dei membri dati.

Costruttori

DataMemberAttribute()

Inizializza una nuova istanza della classe DataMemberAttribute.

Proprietà

EmitDefaultValue	Ottiene o imposta un valore che specifica se serializzare il valore predefinito per un campo o proprietà da serializzare.
IsNameSetExplicitly	Ottiene un valore che indica se Name è stato impostato in modo esplicito.
IsRequired	Ottiene o imposta un valore che indica al motore di serializzazione che il membro deve essere presente al momento della lettura o della deserializzazione.
Name	Ottiene o imposta il nome di un membro dati.
Order	Ottiene o imposta l'ordine di serializzazione e deserializzazione di un membro.
TypeId	Quando è implementata in una classe derivata, ottiene un identificatore univoco della classe Attribute. (Ereditato da Attribute)

Metodi

Equals(Object)	Restituisce un valore che indica se questa istanza è uguale a un oggetto specificato. (Ereditato da Attribute)
GetHashCode()	Restituisce il codice hash per l'istanza. (Ereditato da Attribute)
GetType()	Ottiene l'oggetto Type dell'istanza corrente. (Ereditato da Object)
IsDefaultAttribute()	In caso di override in una classe derivata, indica se il valore di questa istanza è il valore predefinito per la classe derivata. (Ereditato da Attribute)
Match(Object)	Quando è sottoposto a override in una classe derivata, restituisce un valore che indica se questa istanza equivale a un oggetto specificato. (Ereditato da Attribute)
MemberwiseClone()	Crea una copia superficiale dell'oggetto Object corrente. (Ereditato da Object)
ToString()	Restituisce una stringa che rappresenta l'oggetto corrente. (Ereditato da Object)

Si applica a

Vedi anche

• DataContractAttribute
• DataContractSerializer
• IExtensibleDataObject
• Uso di contratti dati
• Procedure consigliate: Controllo delle versioni dei contratti dati
• Valori predefiniti dei membri dati
• Ordine dei membri dati