This topic has not yet been rated - Rate this topic

XmlAttributeOverrides Class

April 12, 2014

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

System.Object
  System.Xml.Serialization.XmlAttributeOverrides

Namespace:  System.Xml.Serialization
Assembly:  System.Xml.Serialization (in System.Xml.Serialization.dll)
public class XmlAttributeOverrides

The XmlAttributeOverrides type exposes the following members.

  NameDescription
Public methodXmlAttributeOverridesInitializes a new instance of the XmlAttributeOverrides class.
Top
  NameDescription
Public propertyItem[Type]Gets the object associated with the specified base-class type.
Public propertyItem[Type, String]Gets the object associated with the specified base-class type. The member parameter specifies the base-class member that is overridden.
Top
  NameDescription
Public methodAdd(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.
Public methodAdd(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.
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

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.

Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Windows Phone

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

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.