XmlAttributeOverrides Class

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Allows you to override property, field, and class attributes when you use the XmlSerializer to serialize or deserialize an object.

Inheritance Hierarchy

System.Object
  System.Xml.Serialization.XmlAttributeOverrides

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

Syntax

'Declaration
<DefaultMemberAttribute("Item")> _
Public Class XmlAttributeOverrides

[DefaultMemberAttribute("Item")]
public class XmlAttributeOverrides

The XmlAttributeOverrides type exposes the following members.

Constructors

	Name	Description
	XmlAttributeOverrides	Initializes a new instance of the XmlAttributeOverrides class.

Top

Properties

	Name	Description
	Item[Type]	Gets the object associated with the specified base-class type.
	Item[Type, String]	Gets the object associated with the specified base-class type. The member parameter specifies the base-class member that is overridden.

Top

Methods

	Name	Description
	Add(Type, XmlAttributes)	Adds an XmlAttributes object to the collection of XmlAttributes objects. The type parameter specifies an object to be overridden by the XmlAttributes object.
	Add(Type, String, XmlAttributes)	Adds an XmlAttributes object to the collection of XmlAttributes objects. The type parameter specifies an object to be overridden. The member parameter specifies the name of a member that is overridden.
	Equals(Object)	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

The XmlAttributeOverrides enables the XmlSerializer to override the default way of serializing a set of objects. Overriding serialization in this way has two uses. First, you can control and augment the serialization of objects found in a DLL, even if you do not have access to the source. Second, you can create one set of serializable classes, but serialize the objects in multiple ways. For example, instead of serializing members of a class instance as XML elements, you can serialize them as XML attributes, resulting in a more efficient document to transport.

After you create an XmlAttributeOverrides object, you pass it as an argument to the XmlSerializer constructor. The resulting XmlSerializer uses the data contained by the XmlAttributeOverrides to override attributes that control how objects are serialized. To accomplish this, the XmlAttributeOverrides contains a collection of the object types that are overridden, as well as an XmlAttributes object associated with each overridden object type. The XmlAttributes object itself contains an appropriate set of attribute objects that control how each field, property, or class is serialized.

The process for creating and using an XmlAttributeOverrides object is as follows:

1. Create an XmlAttributes object.

2. Create an attribute object that is appropriate to the object being overridden. For example, to override a field or property, create an XmlElementAttribute, using the new, derived type. You can optionally assign a new ElementName or Namespace that overrides the base class's attribute name or namespace.

3. Add the attribute object to the appropriate XmlAttributes property or collection. For example, you would add the XmlElementAttribute to the XmlElements collection of the XmlAttributes object, specifying the member name that is being overridden.

4. Create an XmlAttributeOverrides object.

5. Using the Add method, add the XmlAttributes object to the XmlAttributeOverrides object. If the object being overridden is an XmlRootAttribute or XmlTypeAttribute, specify the type of the overridden object. But if you are overriding a field or property, you must also specify the name of the overridden member.

6. When constructing the XmlSerializer, pass the XmlAttributeOverrides to the XmlSerializer constructor.

7. Use the resulting XmlSerializer to serialize or deserialize the derived class objects.

Version Information

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

XNA Framework

Supported in: Xbox 360, Windows Phone OS 7.0

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

Thread Safety

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

See Also

Reference

System.Xml.Serialization Namespace

Deserialize

Serialize

XmlSerializer