XmlAttributes.XmlArray Propriedade

Referência

Definição

Namespace:: System.Xml.Serialization

Assembly:: System.Xml.XmlSerializer.dll

Assembly:: System.Xml.dll

Assembly:: netstandard.dll

Importante

Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.

Obtém ou define um objeto que especifica como o XmlSerializer serializa um campo público ou uma propriedade de leitura/gravação que retorna uma matriz.

public:
 property System::Xml::Serialization::XmlArrayAttribute ^ XmlArray { System::Xml::Serialization::XmlArrayAttribute ^ get(); void set(System::Xml::Serialization::XmlArrayAttribute ^ value); };

public System.Xml.Serialization.XmlArrayAttribute XmlArray { get; set; }

public System.Xml.Serialization.XmlArrayAttribute? XmlArray { get; set; }

member this.XmlArray : System.Xml.Serialization.XmlArrayAttribute with get, set

Public Property XmlArray As XmlArrayAttribute

Valor da propriedade

XmlArrayAttribute

Um XmlArrayAttribute que especifica como o XmlSerializer serializa um campo público ou uma propriedade de leitura/gravação que retorna uma matriz.

Exemplos

O exemplo a seguir serializa uma classe que contém um campo chamado Members que retorna uma matriz de objetos. O XmlArrayAttribute é usado para substituir a serialização do campo e renomear o nome do elemento como Staff.

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

using namespace System;
using namespace System::IO;
using namespace System::Xml;
using namespace System::Xml::Serialization;
public ref class Member
{
public:
   String^ MemberName;
};


// This is the class that will be serialized.
public ref class Group
{
public:

   // This field will be overridden.
   array<Member^>^Members;
};


// Return an XmlSerializer used for overriding. 
XmlSerializer^ CreateOverrider()
{
   // Creating XmlAttributeOverrides and XmlAttributes objects.
   XmlAttributeOverrides^ xOver = gcnew XmlAttributeOverrides;
   XmlAttributes^ xAttrs = gcnew XmlAttributes;

   // Add an override for the XmlArray.    
   XmlArrayAttribute^ xArray = gcnew XmlArrayAttribute( "Staff" );
   xArray->Namespace = "http://www.cpandl.com";
   xAttrs->XmlArray = xArray;
   xOver->Add( Group::typeid, "Members", xAttrs );

   // Create the XmlSerializer and return it.
   return gcnew XmlSerializer( Group::typeid,xOver );
}

void SerializeObject( String^ filename )
{
   // Create an instance of the XmlSerializer class.
   XmlSerializer^ mySerializer = CreateOverrider();

   // Writing the file requires a TextWriter.
   TextWriter^ writer = gcnew StreamWriter( filename );

   // Create an instance of the class that will be serialized.
   Group^ myGroup = gcnew Group;

   // Set the object properties.
   Member^ m = gcnew Member;
   m->MemberName = "Paul";
   array<Member^>^temp = {m};
   myGroup->Members = temp;

   // Serialize the class, and close the TextWriter.
   mySerializer->Serialize( writer, myGroup );
   writer->Close();
}

void DeserializeObject( String^ filename )
{
   XmlSerializer^ mySerializer = CreateOverrider();
   FileStream^ fs = gcnew FileStream( filename,FileMode::Open );
   Group^ myGroup = dynamic_cast<Group^>(mySerializer->Deserialize( fs ));
   System::Collections::IEnumerator^ myEnum = myGroup->Members->GetEnumerator();
   while ( myEnum->MoveNext() )
   {
      Member^ m = safe_cast<Member^>(myEnum->Current);
      Console::WriteLine( m->MemberName );
   }
}

int main()
{
   SerializeObject( "OverrideArray.xml" );
   DeserializeObject( "OverrideArray.xml" );
}

using System;
using System.IO;
using System.Xml;
using System.Xml.Serialization;

// This is the class that will be serialized.
public class Group
{
   // This field will be overridden.
   public Member [] Members;
}

public class Member
{
   public string MemberName;
}

public class Run
{
   public static void Main()
   {
      Run test = new Run();
      test.SerializeObject("OverrideArray.xml");
      test.DeserializeObject("OverrideArray.xml");
   }
   // Return an XmlSerializer used for overriding.
   public XmlSerializer CreateOverrider()
   {
      // Creating XmlAttributeOverrides and XmlAttributes objects.
      XmlAttributeOverrides xOver = new XmlAttributeOverrides();
      XmlAttributes xAttrs = new XmlAttributes();

      // Add an override for the XmlArray.
      XmlArrayAttribute xArray = new XmlArrayAttribute("Staff");
      xArray.Namespace = "http://www.cpandl.com";
      xAttrs.XmlArray = xArray;
      xOver.Add(typeof(Group), "Members", xAttrs);

      // Create the XmlSerializer and return it.
      return new XmlSerializer(typeof(Group), xOver);
   }

   public void SerializeObject(string filename)
   {
      // Create an instance of the XmlSerializer class.
      XmlSerializer mySerializer =  CreateOverrider();
      // Writing the file requires a TextWriter.
      TextWriter writer = new StreamWriter(filename);

      // Create an instance of the class that will be serialized.
      Group myGroup = new Group();

      // Set the object properties.
      Member m = new Member();
      m.MemberName = "Paul";
      myGroup.Members = new Member[1] {m};

      // Serialize the class, and close the TextWriter.
      mySerializer.Serialize(writer, myGroup);
      writer.Close();
   }

   public void DeserializeObject(string filename)
   {
      XmlSerializer mySerializer = CreateOverrider();
      FileStream fs = new FileStream(filename, FileMode.Open);
      Group myGroup = (Group)
      mySerializer.Deserialize(fs);
      foreach(Member m in myGroup.Members)
      {
         Console.WriteLine(m.MemberName);
      }
   }
}

Imports System.IO
Imports System.Xml
Imports System.Xml.Serialization


' This is the class that will be serialized.
Public Class Group
    ' This field will be overridden.
    Public Members() As Member
End Class

Public Class Member
    Public MemberName As String
End Class

Public Class Run
    
    Public Shared Sub Main()
        Dim test As New Run()
        test.SerializeObject("OverrideArray.xml")
        test.DeserializeObject("OverrideArray.xml")
    End Sub
    
    ' Return an XmlSerializer used for overriding. 
    Public Function CreateOverrider() As XmlSerializer
        ' Creating XmlAttributeOverrides and XmlAttributes objects.
        Dim xOver As New XmlAttributeOverrides()
        Dim xAttrs As New XmlAttributes()
        
        ' Add an override for the XmlArray.    
        Dim xArray As New XmlArrayAttribute("Staff")
        xArray.Namespace = "http://www.cpandl.com"
        xAttrs.XmlArray = xArray
        xOver.Add(GetType(Group), "Members", xAttrs)
        
        ' Create the XmlSerializer and return it.
        Return New XmlSerializer(GetType(Group), xOver)
    End Function
    
    Public Sub SerializeObject(ByVal filename As String)
        ' Create an instance of the XmlSerializer class.
        Dim mySerializer As XmlSerializer = CreateOverrider()
        ' Writing the file requires a TextWriter.
        Dim writer As New StreamWriter(filename)
        
        ' Create an instance of the class that will be serialized.
        Dim myGroup As New Group()
        
        ' Set the object properties.
        Dim m As New Member()
        m.MemberName = "Paul"
        myGroup.Members = New Member(0) {m}
        
        ' Serialize the class, and close the TextWriter.
        mySerializer.Serialize(writer, myGroup)
        writer.Close()
    End Sub    
    
    Public Sub DeserializeObject(ByVal filename As String)
        Dim mySerializer As XmlSerializer = CreateOverrider()
        Dim fs As New FileStream(filename, FileMode.Open)
        Dim myGroup As Group = CType(mySerializer.Deserialize(fs), Group)
        Dim m As Member
        For Each m In  myGroup.Members
            Console.WriteLine(m.MemberName)
        Next m
    End Sub
End Class

Comentários

Há duas maneiras pelas quais um campo público ou uma propriedade pública de leitura/gravação que retorna uma matriz é serializada pela XmlSerializerserialização padrão e pela serialização controlada.

Na serialização padrão, nenhum atributo é aplicado ao membro. Quando serializada, a matriz é serializada como uma sequência aninhada de elementos XML com o nome do elemento XML da sequência aninhada tirada do nome do membro.

Para controlar a serialização com mais precisão, aplique um XmlArrayAttribute ao campo ou à propriedade. Por exemplo, você pode alterar o nome do elemento XML gerado do padrão para um nome diferente definindo a ElementName propriedade como um novo valor.

A XmlArray propriedade permite substituir a serialização padrão, bem como a serialização controlada pela aplicação de um XmlArrayAttribute ao membro. Por exemplo, você pode alterar o nome do elemento XML gerado do padrão (o identificador do membro) para um novo valor. Além disso, se você aplicar um XmlArrayAttribute a um membro, ele será substituído por qualquer XmlArrayAttribute um atribuído à XmlArray propriedade.

Aplica-se a