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.Collections::CollectionBase
    System.Xml.Serialization::XmlElementAttributes

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

public ref class XmlElementAttributes : public CollectionBase

The XmlElementAttributes type exposes the following members.

  NameDescription
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsXmlElementAttributesInitializes 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.)
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 LibrarySupported in .NET for Windows Store appsItemGets 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 LibrarySupported in .NET for Windows Store appsAddAdds an XmlElementAttribute to the collection.
Public methodSupported by the XNA FrameworkClearRemoves all objects from the CollectionBase instance. This method cannot be overridden. (Inherited from CollectionBase.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsContainsDetermines whether the collection contains the specified object.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsCopyToCopies the XmlElementAttributes, or a portion of it to a one-dimensional array.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsFinalizeAllows 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 FrameworkGetEnumeratorReturns an enumerator that iterates through the CollectionBase instance. (Inherited from CollectionBase.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsIndexOfGets the index of the specified XmlElementAttribute.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsInsertInserts an XmlElementAttribute into the collection.
Protected methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsMemberwiseCloneCreates 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 LibrarySupported in .NET for Windows Store appsRemoveRemoves the specified object from the collection.
Public methodSupported by the XNA FrameworkRemoveAtRemoves the element at the specified index of the CollectionBase instance. This method is not overridable. (Inherited from CollectionBase.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Public Extension MethodSupported by Portable Class LibrarySupported in .NET for Windows Store appsAsParallelEnables parallelization of a query. (Defined by ParallelEnumerable.)
Public Extension MethodSupported by Portable Class LibrarySupported in .NET for Windows Store appsAsQueryableConverts an IEnumerable to an IQueryable. (Defined by Queryable.)
Public Extension MethodSupported by Portable Class LibrarySupported in .NET for Windows Store appsCast<TResult>Casts the elements of an IEnumerable to the specified type. (Defined by Enumerable.)
Public Extension MethodSupported by Portable Class LibrarySupported in .NET for Windows Store appsOfType<TResult>Filters the elements of an IEnumerable based on a specified type. (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 LibrarySupported in .NET for Windows Store appsICollection::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 LibrarySupported in .NET for Windows Store appsICollection::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 LibrarySupported in .NET for Windows Store appsICollection::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 LibrarySupported in .NET for Windows Store appsIList::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 LibrarySupported in .NET for Windows Store appsIList::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 LibrarySupported in .NET for Windows Store appsIList::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 LibrarySupported in .NET for Windows Store appsIList::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 LibrarySupported in .NET for Windows Store appsIList::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 LibrarySupported in .NET for Windows Store appsIList::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 LibrarySupported in .NET for Windows Store appsIList::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 LibrarySupported in .NET for Windows Store appsIList::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.Xml.dll>
#using <System.dll>

using namespace System;
using namespace System::IO;
using namespace System::Xml::Serialization;
using namespace System::Collections;
using namespace System::Xml;

public ref class Car
{
public:
   String^ Name;
};

public ref class Plane
{
public:
   String^ Name;
};

public ref class Truck
{
public:
   String^ Name;
};

public ref class Train
{
public:
   String^ Name;
};

public ref class Transportation
{
public:

   // Override these two XmlElementAttributes.

   [XmlElement(Car::typeid),
   XmlElement(Plane::typeid)]
   ArrayList^ Vehicles;
};

XmlSerializer^ CreateOverrider()
{
   // Create XmlAtrributes and XmlAttributeOverrides instances. 
   XmlAttributes^ attrs = gcnew XmlAttributes;
   XmlAttributeOverrides^ xOver = gcnew XmlAttributeOverrides;

   /* Create an XmlElementAttributes object to override 
      one of the attributes applied to the Vehicles property. */
   XmlElementAttribute^ xElement1 = gcnew XmlElementAttribute( Truck::typeid );

   // Add the XmlElementAttribute to the collection.
   attrs->XmlElements->Add( xElement1 );

   /* Create a second XmlElementAttribute and 
      add it to the collection. */
   XmlElementAttribute^ xElement2 = gcnew XmlElementAttribute( Train::typeid );
   attrs->XmlElements->Add( xElement2 );

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

   // Create the XmlSerializer, and return it.
   XmlSerializer^ xSer = gcnew XmlSerializer( Transportation::typeid,xOver );
   return xSer;
}

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

   // Create the object.
   Transportation^ myTransportation = gcnew Transportation;

   /* Create two new, overriding objects that can be
      inserted into the Vehicles array. */
   myTransportation->Vehicles = gcnew ArrayList;
   Truck^ myTruck = gcnew Truck;
   myTruck->Name = "MyTruck";
   Train^ myTrain = gcnew Train;
   myTrain->Name = "MyTrain";
   myTransportation->Vehicles->Add( myTruck );
   myTransportation->Vehicles->Add( myTrain );
   TextWriter^ writer = gcnew StreamWriter( filename );
   xSer->Serialize( writer, myTransportation );
}

int main()
{
   SerializeObject( "OverrideElement.xml" );
}

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone 8, Silverlight 8.1

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

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:
© 2014 Microsoft