XmlAttributes::XmlArrayItems Property


Gets or sets a collection of objects that specify how the XmlSerializer serializes items inserted into an array returned by a public field or read/write property.

Namespace:   System.Xml.Serialization
Assembly:  System.Xml (in System.Xml.dll)

property XmlArrayItemAttributes^ XmlArrayItems {
	XmlArrayItemAttributes^ get();

Property Value

Type: System.Xml.Serialization::XmlArrayItemAttributes^

An XmlArrayItemAttributes object that contains a collection of XmlArrayItemAttribute objects.

The XmlArrayItems property allows you to specify the derived types that can be inserted into an array returned by a public field or public read/write property. For each new type you want the field or property to accept, create an XmlArrayItemAttribute object and Add it to the XmlArrayItemAttributes) returned by the XmlArrayItems property. (The new type must be derived from the type already accepted by the field or property.) Add the XmlAttributes object to an XmlAttributeOverrides object and specify the type of the object that contains the field or property, and the name of the field or property. Construct an XmlSerializer with the XmlAttributeOverrides object before calling Serialize or Deserialize method.

The following example serializes a class that contains a field named Members that returns an array of objects. Two XmlArrayItemAttribute objects are created to allow the field to accept objects that derive from the base class named Member. Each object is added to the XmlAttributes through the XmlArrayItems property.

#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
   String^ MemberName;

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

public ref class NewMember: public Member
   int MemberID;

public ref class RetiredMember: public NewMember
   DateTime RetireDate;

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

   // Add an override for the XmlArrayItem.    
   XmlArrayItemAttribute^ xArrayItem = gcnew XmlArrayItemAttribute( NewMember::typeid );
   xArrayItem->Namespace = "http://www.cpandl.com";
   xAttrs->XmlArrayItems->Add( xArrayItem );

   // Add a second override.
   XmlArrayItemAttribute^ xArrayItem2 = gcnew XmlArrayItemAttribute( RetiredMember::typeid );
   xArrayItem2->Namespace = "http://www.cpandl.com";
   xAttrs->XmlArrayItems->Add( xArrayItem2 );

   // Add all overrides to XmlAttribueOverrides object.
   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.
   NewMember^ m = gcnew NewMember;
   m->MemberName = "Paul";
   m->MemberID = 2;

   // Create a second member.
   RetiredMember^ m2 = gcnew RetiredMember;
   m2->MemberName = "Renaldo";
   m2->MemberID = 23;
   m2->RetireDate = DateTime(2000,10,10);
   array<Member^>^temp = {m,m2};
   myGroup->Members = temp;

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

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( "OverrideArrayItem.xml" );
   DeserializeObject( "OverrideArrayItem.xml" );

Universal Windows Platform
Available since 8
.NET Framework
Available since 1.1
Portable Class Library
Supported in: portable .NET platforms
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1
Return to top