Export (0) Print
Expand All

XmlElementAttributes Class

Represents a collection of XmlElementAttribute objects used by the XmlSerializer to override the default way it serializes a class.

System.Object
  System.Xml.Serialization.XmlElementAttributes

Namespace:  System.Xml.Serialization
Assemblies:   System.Xml.XmlSerializer (in System.Xml.XmlSerializer.dll)
  System.Xml (in System.Xml.dll)

public class XmlElementAttributes : IList, 
	ICollection, IEnumerable

The XmlElementAttributes type exposes the following members.

  NameDescription
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryXmlElementAttributesInitializes a new instance of the XmlElementAttributes class.
Top

  NameDescription
Public propertySupported by the XNA FrameworkCapacityGets or sets the number of elements that the CollectionBase can contain. (Inherited from CollectionBase.)
Public propertySupported by the XNA FrameworkCountGets the number of elements contained in the CollectionBase instance. This property cannot be overridden. (Inherited from CollectionBase.)
Public propertySupported by Portable Class LibraryCountGets the number of elements contained in the XmlElementAttributes.
Protected propertySupported by the XNA FrameworkInnerListGets an ArrayList containing the list of elements in the CollectionBase instance. (Inherited from CollectionBase.)
Public propertySupported by the XNA FrameworkSupported by Portable Class LibraryItemGets or sets the element at the specified index.
Protected propertySupported by the XNA FrameworkListGets an IList containing the list of elements in the CollectionBase instance. (Inherited from CollectionBase.)
Top

  NameDescription
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryAddAdds an XmlElementAttribute to the collection.
Public methodSupported by the XNA FrameworkClear()Removes all objects from the CollectionBase instance. This method cannot be overridden. (Inherited from CollectionBase.)
Public methodSupported by Portable Class LibraryClear()Removes all elements from the XmlElementAttributes.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryContainsDetermines whether the collection contains the specified object.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryCopyToCopies the XmlElementAttributes, or a portion of it to a one-dimensional array.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodSupported by the XNA FrameworkSupported by Portable Class LibraryFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodSupported by the XNA FrameworkGetEnumerator()Returns an enumerator that iterates through the CollectionBase instance. (Inherited from CollectionBase.)
Public methodSupported by Portable Class LibraryGetEnumerator()Returns an enumerator for the entire XmlElementAttributes.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryIndexOfGets the index of the specified XmlElementAttribute.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryInsertInserts an XmlElementAttribute into the collection.
Protected methodSupported by the XNA FrameworkSupported by Portable Class LibraryMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodSupported by the XNA FrameworkOnClearPerforms additional custom processes when clearing the contents of the CollectionBase instance. (Inherited from CollectionBase.)
Protected methodSupported by the XNA FrameworkOnClearCompletePerforms additional custom processes after clearing the contents of the CollectionBase instance. (Inherited from CollectionBase.)
Protected methodSupported by the XNA FrameworkOnInsertPerforms additional custom processes before inserting a new element into the CollectionBase instance. (Inherited from CollectionBase.)
Protected methodSupported by the XNA FrameworkOnInsertCompletePerforms additional custom processes after inserting a new element into the CollectionBase instance. (Inherited from CollectionBase.)
Protected methodSupported by the XNA FrameworkOnRemovePerforms additional custom processes when removing an element from the CollectionBase instance. (Inherited from CollectionBase.)
Protected methodSupported by the XNA FrameworkOnRemoveCompletePerforms additional custom processes after removing an element from the CollectionBase instance. (Inherited from CollectionBase.)
Protected methodSupported by the XNA FrameworkOnSetPerforms additional custom processes before setting a value in the CollectionBase instance. (Inherited from CollectionBase.)
Protected methodSupported by the XNA FrameworkOnSetCompletePerforms additional custom processes after setting a value in the CollectionBase instance. (Inherited from CollectionBase.)
Protected methodSupported by the XNA FrameworkOnValidatePerforms additional custom processes when validating a value. (Inherited from CollectionBase.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryRemoveRemoves the specified object from the collection.
Public methodSupported by the XNA FrameworkRemoveAt(Int32)Removes the element at the specified index of the CollectionBase instance. This method is not overridable. (Inherited from CollectionBase.)
Public methodSupported by Portable Class LibraryRemoveAt(Int32)Removes the XmlElementAttributes item at the specified index.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Public Extension MethodSupported by Portable Class LibraryAsParallel()Overloaded. Enables parallelization of a query. (Defined by ParallelEnumerable.)
Public Extension MethodSupported by Portable Class LibraryAsParallel()Overloaded. (Defined by ParallelEnumerable.)
Public Extension MethodSupported by Portable Class LibraryAsQueryable()Overloaded. Converts an IEnumerable to an IQueryable. (Defined by Queryable.)
Public Extension MethodSupported by Portable Class LibraryAsQueryable()Overloaded. (Defined by Queryable.)
Public Extension MethodSupported by Portable Class LibraryCast<TResult>()Overloaded. Casts the elements of an IEnumerable to the specified type. (Defined by Enumerable.)
Public Extension MethodSupported by Portable Class LibraryCast<TResult>()Overloaded. (Defined by Enumerable.)
Public Extension MethodSupported by Portable Class LibraryOfType<TResult>()Overloaded. Filters the elements of an IEnumerable based on a specified type. (Defined by Enumerable.)
Public Extension MethodSupported by Portable Class LibraryOfType<TResult>()Overloaded. (Defined by Enumerable.)
Top

  NameDescription
Explicit interface implemetationPrivate methodSupported by the XNA FrameworkICollection.CopyTo(Array, Int32)Copies the entire CollectionBase to a compatible one-dimensional Array, starting at the specified index of the target array. (Inherited from CollectionBase.)
Explicit interface implemetationPrivate methodSupported by Portable Class LibraryICollection.CopyTo(Array, Int32)Copies the entire XmlElementAttributes to a compatible one-dimensional Array, starting at the specified index of the target array.
Explicit interface implemetationPrivate propertySupported by the XNA FrameworkICollection.IsSynchronizedGets a value indicating whether access to the CollectionBase is synchronized (thread safe). (Inherited from CollectionBase.)
Explicit interface implemetationPrivate propertySupported by Portable Class LibraryICollection.IsSynchronizedGets a value indicating whether access to the XmlElementAttributes is synchronized (thread safe).
Explicit interface implemetationPrivate propertySupported by the XNA FrameworkICollection.SyncRootGets an object that can be used to synchronize access to the CollectionBase. (Inherited from CollectionBase.)
Explicit interface implemetationPrivate propertySupported by Portable Class LibraryICollection.SyncRootGets an object that can be used to synchronize access to the XmlElementAttributes.
Explicit interface implemetationPrivate methodSupported by the XNA FrameworkIList.Add(Object)Adds an object to the end of the CollectionBase. (Inherited from CollectionBase.)
Explicit interface implemetationPrivate methodSupported by Portable Class LibraryIList.Add(Object)Adds an object to the end of the XmlElementAttributes.
Explicit interface implemetationPrivate methodSupported by the XNA FrameworkIList.Contains(Object)Determines whether the CollectionBase contains a specific element. (Inherited from CollectionBase.)
Explicit interface implemetationPrivate methodSupported by Portable Class LibraryIList.Contains(Object)Determines whether the XmlElementAttributes contains a specific value.
Explicit interface implemetationPrivate methodSupported by the XNA FrameworkIList.IndexOf(Object)Searches for the specified Object and returns the zero-based index of the first occurrence within the entire CollectionBase. (Inherited from CollectionBase.)
Explicit interface implemetationPrivate methodSupported by Portable Class LibraryIList.IndexOf(Object)Determines the index of a specific item in the XmlElementAttributes.
Explicit interface implemetationPrivate methodSupported by the XNA FrameworkIList.Insert(Int32, Object)Inserts an element into the CollectionBase at the specified index. (Inherited from CollectionBase.)
Explicit interface implemetationPrivate methodSupported by Portable Class LibraryIList.Insert(Int32, Object)Inserts an element into the XmlElementAttributes at the specified index.
Explicit interface implemetationPrivate propertySupported by the XNA FrameworkIList.IsFixedSizeGets a value indicating whether the CollectionBase has a fixed size. (Inherited from CollectionBase.)
Explicit interface implemetationPrivate propertySupported by Portable Class LibraryIList.IsFixedSizeGets a value indicating whether the XmlElementAttributes has a fixed size.
Explicit interface implemetationPrivate propertySupported by the XNA FrameworkIList.IsReadOnlyGets a value indicating whether the CollectionBase is read-only. (Inherited from CollectionBase.)
Explicit interface implemetationPrivate propertySupported by Portable Class LibraryIList.IsReadOnlyGets a value indicating whether the XmlElementAttributes is read-only.
Explicit interface implemetationPrivate propertySupported by the XNA FrameworkIList.Item[Int32]Gets or sets the element at the specified index. (Inherited from CollectionBase.)
Explicit interface implemetationPrivate propertySupported by Portable Class LibraryIList.Item[Int32]Gets or sets the element at the specified index.
Explicit interface implemetationPrivate methodSupported by the XNA FrameworkIList.Remove(Object)Removes the first occurrence of a specific object from the CollectionBase. (Inherited from CollectionBase.)
Explicit interface implemetationPrivate methodSupported by Portable Class LibraryIList.Remove(Object)Removes the first occurrence of a specific object from the XmlElementAttributes.
Top

The XmlElementAttributes is returned by the XmlElements property of the XmlAttributes class. By using the XmlAttributeOverrides class and the XmlAttributes class, you can override the default way that the XmlSerializer serializes a class.

The following example serializes the Transportation class, which contains a single field named Vehicles that returns an ArrayList. The example first applies two instances of the XmlElementAttribute class to the Vehicles field that specifies the types of objects the XmlSerializer inserts into the array. The example then creates two XmlElementAttribute objects to override the behavior of the attributes applied to the Vehicles property. The two overriding objects are added to the XmlElementAttributes collection of an XmlAttributes. Lastly, the example adds the XmlAttributes to an XmlAttributeOverrides, allowing the XmlSerializer to insert the new object types into the ArrayList returned by the Vehicles field.

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

public class Transportation
{
   // Override these two XmlElementAttributes.
   [XmlElement(typeof(Car)),
   XmlElement(typeof(Plane))]
   public ArrayList Vehicles;
}

public class Car
{
   public string Name;
}

public class Plane
{
   public string Name;
}

public class Truck
{
   public string Name;
}

public class Train
{
   public string Name;
}

public class Test
{
   public static void Main()
   {
      Test t = new Test();
      t.SerializeObject("OverrideElement.xml");
   }

   public XmlSerializer CreateOverrider()
   {
      // Create XmlAtrributes and XmlAttributeOverrides instances. 

      XmlAttributes attrs = new XmlAttributes();

      XmlAttributeOverrides xOver = 
      new XmlAttributeOverrides();

      /* Create an XmlElementAttributes object to override 
      one of the attributes applied to the Vehicles property. */
      XmlElementAttribute xElement1 = 
      new XmlElementAttribute(typeof(Truck));
      // Add the XmlElementAttribute to the collection.
      attrs.XmlElements.Add(xElement1);

      /* Create a second XmlElementAttribute and 
      add it to the collection. */
      XmlElementAttribute xElement2 = 
      new XmlElementAttribute(typeof(Train));
      attrs.XmlElements.Add(xElement2);

      /* Add the XmlAttributes to the XmlAttributeOverrides,
      specifying the member to override. */
      xOver.Add(typeof(Transportation), "Vehicles", attrs);

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

   public void SerializeObject(string filename)
   {
      // Create an XmlSerializer instance.
      XmlSerializer xSer = CreateOverrider();

      // Create the object.
      Transportation myTransportation = 
      new Transportation();

      /* Create two new, overriding objects that can be
      inserted into the Vehicles array. */
      myTransportation.Vehicles = new ArrayList();
      Truck myTruck = new Truck();
      myTruck.Name = "MyTruck";

      Train myTrain = new Train();
      myTrain.Name = "MyTrain";

      myTransportation.Vehicles.Add(myTruck);
      myTransportation.Vehicles.Add(myTrain);

      TextWriter writer = new StreamWriter(filename);
      xSer.Serialize(writer, myTransportation);
   }
}

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0, 1.1

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

XNA Framework

Supported in: 3.0, 2.0, 1.0

Portable Class Library

Supported in: Portable Class Library

Supported in: Windows Phone 8.1

Supported in: Windows Phone Silverlight 8.1

Supported in: Windows Phone Silverlight 8

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show:
© 2015 Microsoft