Type: System.Xml.Serialization.XmlAnyElementAttributes

System.Xml.Serialization.XmlAnyElementAttributes Class

Assembly: System.Xml.dll
Namespace: System.Xml.Serialization

Summary: Represents a collection of XmlAnyElementAttribute objects.

C# Syntax:


        public class XmlAnyElementAttributes : CollectionBase

Remarks

Use the XmlAnyElementAttributes to override the behavior of a set of XmlAnyElementAttribute objects. Multiple instances of the XmlAnyElementAttribute class can be applied to a class member, as long as each instance has a distinct XmlAnyElementAttribute.Name property value; this instructs the XmlSerializer to collect unknown elements under the named element into the appropriate array. It is for this reason that multiple instances of the XmlAnyElementAttribute class can be added to the XmlAnyElementAttributes.

To override a set of XmlAnyElementAttribute objects:

Create an XmlAnyElementAttributes.
Create the set of XmlAnyElementAttribute objects, and add each object to the collection using the XmlAnyElementAttributes.Add method.
Create an XmlAttributes.
Set the XmlAttributes.XmlAnyElements property to the XmlAnyElementAttributes.
Create an XmlAttributeOverrides.
Add the XmlAttributes to the XmlAttributeOverrides using the XmlAttributeOverrides.Add method.
Create an instance of the XmlSerializer using the XmlAttributeOverrides.
Serialize or deserialize an object that contains the set of XmlAnyElementAttribute objects.

Example

The following example creates a new XmlAnyElementAttribute and adds it to the collection of objects accessed through the XmlAttributes.XmlAnyElements property. The XmlAttributes is then added to a XmlAttributeOverrides which is used to create an XmlSerializer. The XmlSerializer is used to serialize or deserialize an object. To see the effect of using the XmlAnyElementAttributes property, create an XML document named UnknownElements.xml by running the


            SerializeObject

method in the


            Main

method. Edit the resulting document to include other (unknown) elements. Comment out the


            SerializeObject

call in the


            Main

method, and uncomment the call to the


            DeserializeObject

method, which will print out the name and value of any unknown XML element.

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

public class Group{
   public string GroupName;
   [XmlAnyElement]
   public object[]Things;

}

public class Test{
   static void Main(){
      Test t = new Test();
      // 1 Run this and create the XML document.
      // 2 Add new elements to the XML document.
      // 3 Comment out the new line, and uncomment
      // the DeserializeObject line to deserialize the
      // XML document and see unknown elements.
      t.SerializeObject("UnknownElements.xml");
     
      // t.DeserializeObject("UnknownElements.xml");
   }

   private void SerializeObject(string filename){
      XmlSerializer ser = new XmlSerializer(typeof (Group));
      TextWriter writer = new StreamWriter(filename);
      Group g = new Group();
      g.GroupName = "MyGroup";
      ser.Serialize(writer, g);
      writer.Close();
   }

   
   private void DeserializeObject(string filename){

      XmlSerializer ser = CreateOverrideSerializer();
      // A FileStream is needed to read the XML document.
      FileStream fs = new FileStream(filename, FileMode.Open);
     Group g = (Group)
     	ser.Deserialize(fs);
     fs.Close();
     Console.WriteLine(g.GroupName);
     Console.WriteLine(g.Things.Length);
     foreach(XmlElement xelement in g.Things){
     Console.WriteLine(xelement.Name + ": " + xelement.InnerXml);
     }
   }

   private XmlSerializer CreateOverrideSerializer(){
      XmlAnyElementAttribute myAnyElement = 
      new XmlAnyElementAttribute();
      XmlAttributeOverrides xOverride = 
      new XmlAttributeOverrides();
      XmlAttributes xAtts = new XmlAttributes();
      xAtts.XmlAnyElements.Add(myAnyElement);
      xOverride.Add(typeof(Group), "Things", xAtts);
      return new XmlSerializer(typeof(Group) , xOverride);
   }
}

See also:

System.Xml.Serialization Namespace

System.Xml.Serialization.XmlAnyElementAttributes Member List:

Public Constructors

ctor #1

Default constructor. This constructor is called by derived class constructors to initialize state in this type.

Public Properties

Count (inherited from System.Collections.CollectionBase)	Read-only See base class member description: System.Collections.CollectionBase.Count Gets the number of elements contained in the CollectionBase instance.
Item	Read-write Gets or sets the XmlAnyElementAttribute at the specified index.

Public Methods

Add	Adds an XmlAnyElementAttribute to the collection.
Clear (inherited from System.Collections.CollectionBase)	See base class member description: System.Collections.CollectionBase.Clear Removes all objects from the CollectionBase instance.
Contains	Gets a value indicating whether the specified XmlAnyElementAttribute exists in the collection.
CopyTo	Supports the Shared Source CLI infrastructure and is not intended to be used directly from your code
Equals (inherited from System.Object)	See base class member description: System.Object.Equals Derived from System.Object, the primary base class for all objects.
GetEnumerator (inherited from System.Collections.CollectionBase)	See base class member description: System.Collections.CollectionBase.GetEnumerator Returns an enumerator that can iterate through the CollectionBase instance.
GetHashCode (inherited from System.Object)	See base class member description: System.Object.GetHashCode Derived from System.Object, the primary base class for all objects.
GetType (inherited from System.Object)	See base class member description: System.Object.GetType Derived from System.Object, the primary base class for all objects.
IndexOf	Gets the index of the specified XmlAnyElementAttribute.
Insert	Inserts an XmlAnyElementAttribute into the collection at the specified index.
Remove	Removes the specified XmlAnyElementAttribute from the collection.
RemoveAt (inherited from System.Collections.CollectionBase)	See base class member description: System.Collections.CollectionBase.RemoveAt Removes the element at the specified index of the CollectionBase instance.
ToString (inherited from System.Object)	See base class member description: System.Object.ToString Derived from System.Object, the primary base class for all objects.

Protected Properties

InnerList (inherited from System.Collections.CollectionBase)	Read-only See base class member description: System.Collections.CollectionBase.InnerList Gets an ArrayList containing the list of elements in the CollectionBase instance.
List (inherited from System.Collections.CollectionBase)	Read-only See base class member description: System.Collections.CollectionBase.List Gets an IList containing the list of elements in the CollectionBase instance.

Protected Methods

Finalize (inherited from System.Object)	See base class member description: System.Object.Finalize Derived from System.Object, the primary base class for all objects.
MemberwiseClone (inherited from System.Object)	See base class member description: System.Object.MemberwiseClone Derived from System.Object, the primary base class for all objects.
OnClear (inherited from System.Collections.CollectionBase)	See base class member description: System.Collections.CollectionBase.OnClear Performs additional custom processes when clearing the contents of the CollectionBase instance.
OnClearComplete (inherited from System.Collections.CollectionBase)	See base class member description: System.Collections.CollectionBase.OnClearComplete Performs additional custom processes after clearing the contents of the CollectionBase instance.
OnInsert (inherited from System.Collections.CollectionBase)	See base class member description: System.Collections.CollectionBase.OnInsert Performs additional custom processes before inserting a new element into the CollectionBase instance.
OnInsertComplete (inherited from System.Collections.CollectionBase)	See base class member description: System.Collections.CollectionBase.OnInsertComplete Performs additional custom processes after inserting a new element into the CollectionBase instance.
OnRemove (inherited from System.Collections.CollectionBase)	See base class member description: System.Collections.CollectionBase.OnRemove Performs additional custom processes when removing an element from the CollectionBase instance.
OnRemoveComplete (inherited from System.Collections.CollectionBase)	See base class member description: System.Collections.CollectionBase.OnRemoveComplete Performs additional custom processes after removing an element from the CollectionBase instance.
OnSet (inherited from System.Collections.CollectionBase)	See base class member description: System.Collections.CollectionBase.OnSet Performs additional custom processes before setting a value in the CollectionBase instance.
OnSetComplete (inherited from System.Collections.CollectionBase)	See base class member description: System.Collections.CollectionBase.OnSetComplete Performs additional custom processes after setting a value in the CollectionBase instance.
OnValidate (inherited from System.Collections.CollectionBase)	See base class member description: System.Collections.CollectionBase.OnValidate Performs additional custom processes when validating a value.

Hierarchy:

System.Object

System.Collections.CollectionBase

System.Xml.Serialization.XmlAnyElementAttributes

System.Xml.Serialization.XmlAnyElementAttributes Member Details

ctor #1

Summary:: Default constructor. This constructor is called by derived class constructors to initialize state in this type.

C# Syntax:


            public XmlAnyElementAttributes();