XmlElementAttribute XmlElementAttribute XmlElementAttribute XmlElementAttribute Class

Definizione

Indica che una proprietà o un campo public rappresenta un elemento XML quando XmlSerializer serializza o deserializza l'oggetto in cui è contenuto.Indicates that a public field or property represents an XML element when the XmlSerializer serializes or deserializes the object that contains it.

public ref class XmlElementAttribute : Attribute
[System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Parameter | System.AttributeTargets.Property | System.AttributeTargets.ReturnValue, AllowMultiple=true)]
[System.AttributeUsage(System.AttributeTargets.Property | System.AttributeTargets.Field | System.AttributeTargets.Parameter | System.AttributeTargets.ReturnValue, AllowMultiple=true)]
public class XmlElementAttribute : Attribute
type XmlElementAttribute = class
    inherit Attribute
Public Class XmlElementAttribute
Inherits Attribute
Ereditarietà
XmlElementAttributeXmlElementAttributeXmlElementAttributeXmlElementAttribute
Attributi

Esempi

Nell'esempio seguente serializza una classe denominata Group e applica il XmlElementAttribute a molti dei suoi membri.The following example serializes a class named Group and applies the XmlElementAttribute to several of its members. Il campo denominato Employees restituisce una matrice di Employee oggetti.The field named Employees returns an array of Employee objects. In questo caso, il XmlElementAttribute specifica che il codice XML risultante non deve essere annidato (ovvero il comportamento predefinito di elementi in una matrice).In this case, the XmlElementAttribute specifies that the resulting XML will not be nested (which is the default behavior of items in an array).

#using <System.Xml.dll>
#using <System.dll>

using namespace System;
using namespace System::Collections;
using namespace System::IO;
using namespace System::Xml::Serialization;
public ref class Employee
{
public:
   String^ Name;
};

public ref class Manager: public Employee
{
public:
   int Level;
};

public ref class Group
{
public:

   /* Set the element name and namespace of the XML element.
      By applying an XmlElementAttribute to an array,  you instruct
      the XmlSerializer to serialize the array as a series of XML
      elements, instead of a nested set of elements. */

   [XmlElement(
   ElementName="Members",
   Namespace="http://www.cpandl.com")]
   array<Employee^>^Employees;

   [XmlElement(DataType="snippet1>",
   ElementName="Building")]
   double GroupID;

   [XmlElement(DataType="hexBinary")]
   array<Byte>^HexBytes;

   [XmlElement(DataType="boolean")]
   bool IsActive;

   [XmlElement(Type=::Manager::typeid)]
   Employee^ Manager;

   [XmlElement(Int32::typeid,
   ElementName="ObjectNumber"),
   XmlElement(String::typeid,
   ElementName="ObjectString")]
   ArrayList^ ExtraInfo;
};

void SerializeObject( String^ filename )
{
   // Create the XmlSerializer.
   XmlSerializer^ s = gcnew XmlSerializer( Group::typeid );

   // To write the file, a TextWriter is required.
   TextWriter^ writer = gcnew StreamWriter( filename );

   /* Create an instance of the group to serialize, and set
      its properties. */
   Group^ group = gcnew Group;
   group->GroupID = 10.089f;
   group->IsActive = false;
   array<Byte>^temp0 = {Convert::ToByte( 100 )};
   group->HexBytes = temp0;
   Employee^ x = gcnew Employee;
   Employee^ y = gcnew Employee;
   x->Name = "Jack";
   y->Name = "Jill";
   array<Employee^>^temp1 = {x,y};
   group->Employees = temp1;
   Manager^ mgr = gcnew Manager;
   mgr->Name = "Sara";
   mgr->Level = 4;
   group->Manager = mgr;

   /* Add a number and a string to the 
      ArrayList returned by the ExtraInfo property. */
   group->ExtraInfo = gcnew ArrayList;
   group->ExtraInfo->Add( 42 );
   group->ExtraInfo->Add( "Answer" );

   // Serialize the object, and close the TextWriter.      
   s->Serialize( writer, group );
   writer->Close();
}

void DeserializeObject( String^ filename )
{
   FileStream^ fs = gcnew FileStream( filename,FileMode::Open );
   XmlSerializer^ x = gcnew XmlSerializer( Group::typeid );
   Group^ g = dynamic_cast<Group^>(x->Deserialize( fs ));
   Console::WriteLine( g->Manager->Name );
   Console::WriteLine( g->GroupID );
   Console::WriteLine( g->HexBytes[ 0 ] );
   IEnumerator^ myEnum = g->Employees->GetEnumerator();
   while ( myEnum->MoveNext() )
   {
      Employee^ e = safe_cast<Employee^>(myEnum->Current);
      Console::WriteLine( e->Name );
   }
}

int main()
{
   SerializeObject( "FirstDoc.xml" );
   DeserializeObject( "FirstDoc.xml" );
}
using System;
using System.Collections;
using System.IO;
using System.Xml.Serialization;

public class Group
{
   /* Set the element name and namespace of the XML element.
   By applying an XmlElementAttribute to an array,  you instruct
   the XmlSerializer to serialize the array as a series of XML
   elements, instead of a nested set of elements. */
   
   [XmlElement(
   ElementName = "Members",
   Namespace = "http://www.cpandl.com")]
   public Employee[] Employees;
      
   [XmlElement(DataType = "double",
   ElementName = "Building")]
   public double GroupID;

   [XmlElement(DataType = "hexBinary")]
   public byte [] HexBytes;


   [XmlElement(DataType = "boolean")]
   public bool IsActive;

   [XmlElement(Type = typeof(Manager))]
   public Employee Manager;

   [XmlElement(typeof(int),
   ElementName = "ObjectNumber"),
   XmlElement(typeof(string),
   ElementName = "ObjectString")]
   public ArrayList ExtraInfo;
}   

public class Employee
{
   public string Name;
}

public class Manager:Employee{
   public int Level;
}

public class Run
{
    public static void Main()
    {
       Run test = new Run();
       test.SerializeObject("FirstDoc.xml");
       test.DeserializeObject("FirstDoc.xml");
    }


   public void SerializeObject(string filename)
   {
      // Create the XmlSerializer.
      XmlSerializer s = new XmlSerializer(typeof(Group));

      // To write the file, a TextWriter is required.
      TextWriter writer = new StreamWriter(filename);

      /* Create an instance of the group to serialize, and set
         its properties. */
      Group group = new Group();
      group.GroupID = 10.089f;
      group.IsActive = false;
      
      group.HexBytes = new byte[1]{Convert.ToByte(100)};

      Employee x = new Employee();
      Employee y = new Employee();

      x.Name = "Jack";
      y.Name = "Jill";
      
      group.Employees = new Employee[2]{x,y};

      Manager mgr = new Manager();
      mgr.Name = "Sara";
      mgr.Level = 4;
      group.Manager = mgr;

      /* Add a number and a string to the 
      ArrayList returned by the ExtraInfo property. */
      group.ExtraInfo = new ArrayList();
      group.ExtraInfo.Add(42);
      group.ExtraInfo.Add("Answer");

      // Serialize the object, and close the TextWriter.      
      s.Serialize(writer, group);
      writer.Close();
   }

   public void DeserializeObject(string filename)
   {
      FileStream fs = new FileStream(filename, FileMode.Open);
      XmlSerializer x = new XmlSerializer(typeof(Group));
      Group g = (Group) x.Deserialize(fs);
      Console.WriteLine(g.Manager.Name);
      Console.WriteLine(g.GroupID);
      Console.WriteLine(g.HexBytes[0]);
      foreach(Employee e in g.Employees)
      {
         Console.WriteLine(e.Name);
      }
   }
}
   
Imports System
Imports System.Collections
Imports System.IO
Imports System.Xml.Serialization


Public Class Group
    ' Set the element name and namespace of the XML element.
    <XmlElement(ElementName := "Members", _
     Namespace := "http://www.cpandl.com")> _    
    Public Employees() As Employee
    
    <XmlElement(DataType := "double", _
     ElementName := "Building")> _
    Public GroupID As Double
    
    <XmlElement(DataType := "hexBinary")> _
    Public HexBytes() As Byte
    
    <XmlElement(DataType := "boolean")> _
    Public IsActive As Boolean
    
    <XmlElement(GetType(Manager))> _
    Public Manager As Employee
    
    <XmlElement(GetType(Integer), _
        ElementName := "ObjectNumber"), _
     XmlElement(GetType(String), _
        ElementName := "ObjectString")> _
    Public ExtraInfo As ArrayList
End Class

Public Class Employee
    Public Name As String
End Class

Public Class Manager
    Inherits Employee
    Public Level As Integer
End Class

Public Class Run
    
    Public Shared Sub Main()
        Dim test As New Run()
        test.SerializeObject("FirstDoc.xml")
        test.DeserializeObject("FirstDoc.xml")
    End Sub
    
    Public Sub SerializeObject(filename As String)
        ' Create the XmlSerializer.
        Dim s As New XmlSerializer(GetType(Group))
        
        ' To write the file, a TextWriter is required.
        Dim writer As New StreamWriter(filename)
        
        ' Create an instance of the group to serialize, and set
        ' its properties. 
        Dim group As New Group()
        group.GroupID = 10.089f
        group.IsActive = False
        
        group.HexBytes = New Byte() {Convert.ToByte(100)}
        
        Dim x As New Employee()
        Dim y As New Employee()
        
        x.Name = "Jack"
        y.Name = "Jill"
        
        group.Employees = New Employee() {x, y}
        
        Dim mgr As New Manager()
        mgr.Name = "Sara"
        mgr.Level = 4
        group.Manager = mgr
        
        ' Add a number and a string to the
        ' ArrayList returned by the ExtraInfo property. 
        group.ExtraInfo = New ArrayList()
        group.ExtraInfo.Add(42)
        group.ExtraInfo.Add("Answer")
        
        ' Serialize the object, and close the TextWriter.      
        s.Serialize(writer, group)
        writer.Close()
    End Sub    
    
    Public Sub DeserializeObject(filename As String)
        Dim fs As New FileStream(filename, FileMode.Open)
        Dim x As New XmlSerializer(GetType(Group))
        Dim g As Group = CType(x.Deserialize(fs), Group)
        Console.WriteLine(g.Manager.Name)
        Console.WriteLine(g.GroupID)
        Console.WriteLine(g.HexBytes(0))

        Dim e As Employee
        For Each e In g.Employees
            Console.WriteLine(e.Name)
        Next e
    End Sub
End Class

Commenti

Il XmlElementAttribute appartiene a una famiglia di attributi che controlla come il XmlSerializer serializza o deserializza un oggetto.The XmlElementAttribute belongs to a family of attributes that controls how the XmlSerializer serializes or deserializes an object. Per un elenco completo degli attributi simili, vedere gli attributi che controllano la serializzazione XML.For a complete list of similar attributes, see Attributes That Control XML Serialization.

In genere, un documento XML contiene elementi XML, ognuno dei quali è costituito da tre parti: un tag di apertura con gli eventuali attributi, un tag di chiusura e i dati tra i tag.An XML document usually contains XML elements, each of which consists of three parts: an opening tag with possible attributes, a closing tag, and the data between the tags. I tag XML possono essere annidati, ovvero, i dati tra i tag possono essere anche elementi XML.XML tags can be nested--that is, the data between tags can also be XML elements. Questa capacità di un elemento per racchiudere un'altra consente di documento contengono gerarchie di dati.This capacity of one element to enclose another allows the document to contain hierarchies of data. Un elemento XML può includere anche gli attributi.An XML element can also include attributes.

Applicare il XmlElementAttribute ai campi pubblici o le proprietà di lettura/scrittura pubblica per controllare le caratteristiche degli elementi XML, ad esempio il nome dell'elemento e lo spazio dei nomi.Apply the XmlElementAttribute to public fields or public read/write properties to control characteristics of the XML elements such as the element name and namespace.

Il XmlElementAttribute può essere applicato più volte a un campo che restituisce una matrice di oggetti.The XmlElementAttribute can be applied multiple times to a field that returns an array of objects. Lo scopo di questo consiste nello specificare (mediante il Type proprietà) diversi tipi che possono essere inseriti nella matrice.The purpose of this is to specify (through the Type property) different types that can be inserted into the array. Ad esempio, la matrice nel codice c# seguente accetta numeri interi e stringhe.For example, the array in the following C# code accepts both strings and integers.

public class Things{  
   [XmlElement(Type = typeof(string)),  
   XmlElement(Type = typeof(int))]  
   public object[] StringsAndInts;  
}  

Il risultato XML potrebbe assomigliare agli elementi seguenti.This results in XML that might resemble the following.

<Things>  
   <string>Hello</string>  
   <int>999</int>  
   <string>World</string>  
</Things>  

Si noti che quando si applica il XmlElementAttribute più volte senza specificare un ElementName valore della proprietà, gli elementi vengono denominati dopo il tipo degli oggetti accettabili.Note that when you apply the XmlElementAttribute multiple times without specifying an ElementName property value, the elements are named after the type of the acceptable objects.

Se si applica il XmlElementAttribute a un campo o proprietà che restituisce una matrice, gli elementi nella matrice sono codificati come una sequenza di elementi XML.If you apply the XmlElementAttribute to a field or property that returns an array, the items in the array are encoded as a sequence of XML elements.

Invece se un XmlElementAttribute non viene applicato a un campo o una proprietà, gli elementi nella matrice sono codificati come una sequenza di elementi, annidato in un elemento denominato al campo o della proprietà.In contrast if an XmlElementAttribute is not applied to such a field or property, the items in the array are encoded as a sequence of elements, nested under an element named after the field or property. (Usare il XmlArrayAttribute e XmlArrayItemAttribute attributi per controllare la serializzazione di una matrice.)(Use the XmlArrayAttribute and XmlArrayItemAttribute attributes to control how an array is serialized.)

È possibile impostare il Type proprietà per specificare un tipo derivato dal tipo del campo originale o della proprietà, vale a dire, il campo o proprietà a cui è stato applicato il XmlElementAttribute.You can set the Type property to specify a type that is derived from the type of the original field or property--that is, the field or property to which you have applied the XmlElementAttribute.

Se un campo o proprietà restituisce un ArrayList, è possibile applicare più istanze del XmlElementAttribute al membro.If a field or property returns an ArrayList, you can apply multiple instances of the XmlElementAttribute to the member. Per ogni istanza, impostare il Type proprietà a un tipo di oggetto che può essere inserito nella matrice.For each instance, set the Type property to a type of object that can be inserted into the array.

Per altre informazioni sull'utilizzo di attributi, vedere attributi.For more information about using attributes, see Attributes.

Nota

È possibile usare la parola XmlElement nel codice anziché la forma estesa XmlElementAttribute.You can use the word XmlElement in your code instead of the longer XmlElementAttribute.

Costruttori

XmlElementAttribute() XmlElementAttribute() XmlElementAttribute() XmlElementAttribute()

Inizializza una nuova istanza della classe XmlElementAttribute.Initializes a new instance of the XmlElementAttribute class.

XmlElementAttribute(String) XmlElementAttribute(String) XmlElementAttribute(String) XmlElementAttribute(String)

Consente di inizializzare una nuova istanza della classe XmlElementAttribute e di specificare il nome dell'elemento XML.Initializes a new instance of the XmlElementAttribute class and specifies the name of the XML element.

XmlElementAttribute(String, Type) XmlElementAttribute(String, Type) XmlElementAttribute(String, Type) XmlElementAttribute(String, Type)

Inizializza una nuova istanza di XmlElementAttribute e specifica il nome dell'elemento XML e un tipo derivato per il membro a cui viene applicato XmlElementAttribute.Initializes a new instance of the XmlElementAttribute and specifies the name of the XML element and a derived type for the member to which the XmlElementAttribute is applied. Questo tipo di membro viene utilizzato quando XmlSerializer serializza l'oggetto in cui è contenuto.This member type is used when the XmlSerializer serializes the object that contains it.

XmlElementAttribute(Type) XmlElementAttribute(Type) XmlElementAttribute(Type) XmlElementAttribute(Type)

Inizializza una nuova istanza di XmlElementAttribute e specifica un tipo per il membro a cui viene applicato XmlElementAttribute.Initializes a new instance of the XmlElementAttribute class and specifies a type for the member to which the XmlElementAttribute is applied. Questo tipo viene utilizzato da XmlSerializer durante la serializzazione o la deserializzazione dell'oggetto in cui è contenuto.This type is used by the XmlSerializer when serializing or deserializing object that contains it.

Proprietà

DataType DataType DataType DataType

Ottiene o imposta il tipo di dati XSD (XML Schema Definition) dell'elemento XML generato da XmlSerializer.Gets or sets the XML Schema definition (XSD) data type of the XML element generated by the XmlSerializer.

ElementName ElementName ElementName ElementName

Ottiene o imposta il nome dell'elemento XML generato.Gets or sets the name of the generated XML element.

Form Form Form Form

Ottiene o imposta un valore che indica se l'elemento è completo.Gets or sets a value that indicates whether the element is qualified.

IsNullable IsNullable IsNullable IsNullable

Ottiene o imposta un valore che indica se XmlSerializer deve serializzare un membro impostato su null come un tag vuoto con l'attributo xsi:nil impostato su true.Gets or sets a value that indicates whether the XmlSerializer must serialize a member that is set to null as an empty tag with the xsi:nil attribute set to true.

Namespace Namespace Namespace Namespace

Ottiene o imposta lo spazio dei nomi assegnato all'elemento XML restituito quando la classe viene serializzata.Gets or sets the namespace assigned to the XML element that results when the class is serialized.

Order Order Order Order

Ottiene o imposta l'ordine esplicito in cui gli elementi vengono serializzati o deserializzati.Gets or sets the explicit order in which the elements are serialized or deserialized.

Type Type Type Type

Ottiene o imposta il tipo di oggetto utilizzato per rappresentare l'elemento XML.Gets or sets the object type used to represent the XML element.

TypeId TypeId TypeId TypeId

Quando è implementata in una classe derivata, ottiene un identificatore univoco della classe Attribute.When implemented in a derived class, gets a unique identifier for this Attribute.

(Inherited from Attribute)

Metodi

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

Restituisce un valore che indica se questa istanza è uguale a un oggetto specificato.Returns a value that indicates whether this instance is equal to a specified object.

(Inherited from Attribute)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Restituisce il codice hash per l'istanza.Returns the hash code for this instance.

(Inherited from Attribute)
GetType() GetType() GetType() GetType()

Ottiene l'oggetto Type dell'istanza corrente.Gets the Type of the current instance.

(Inherited from Object)
IsDefaultAttribute() IsDefaultAttribute() IsDefaultAttribute() IsDefaultAttribute()

In caso di override in una classe derivata, indica se il valore di questa istanza è il valore predefinito per la classe derivata.When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(Inherited from Attribute)
Match(Object) Match(Object) Match(Object) Match(Object)

Quando è sottoposto a override in una classe derivata, restituisce un valore che indica se questa istanza equivale a un oggetto specificato.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Inherited from Attribute)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Crea una copia superficiale dell'oggetto Object corrente.Creates a shallow copy of the current Object.

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

Restituisce una stringa che rappresenta l'oggetto corrente.Returns a string that represents the current object.

(Inherited from Object)

Implementazioni dell'interfaccia esplicita

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) _Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) _Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) _Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

Esegue il mapping di un set di nomi a un set corrispondente di ID dispatch.Maps a set of names to a corresponding set of dispatch identifiers.

(Inherited from Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Recupera le informazioni sul tipo relative a un oggetto, che possono essere usate per ottenere informazioni sul tipo relative a un'interfaccia.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Inherited from Attribute)
_Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32)

Recupera il numero delle interfacce di informazioni sul tipo fornite da un oggetto (0 o 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Inherited from Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Fornisce l'accesso a proprietà e metodi esposti da un oggetto.Provides access to properties and methods exposed by an object.

(Inherited from Attribute)

Si applica a

Vedi anche