XmlAttributes::XmlAttribute Property


Gets or sets an object that specifies how the XmlSerializer serializes a public field or public read/write property as an XML attribute.

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

property XmlAttributeAttribute^ XmlAttribute {
	XmlAttributeAttribute^ get();
	void set(XmlAttributeAttribute^ value);

Property Value

Type: System.Xml.Serialization::XmlAttributeAttribute^

An XmlAttributeAttribute that controls the serialization of a public field or read/write property as an XML attribute.

By default, if no attribute is applied to a public field or public read/write property, it is serialized as an XML element. You can also instruct the XmlSerializer to generate an XML attribute by applying an XmlAttributeAttribute to the field or property.

The XmlAttribute property allows you to override the default serialization, as well as the serialization controlled by applying an XmlAttributeAttribute to the member. To do this, create an XmlAttributeAttribute and set its properties (such as AttributeName). Assign the new object to the XmlAttribute property of an XmlAttributes object. Add the XmlAttributes object to an XmlAttributeOverrides object and specify the type of the object that contains the field or property, and the name of the field or property. Lastly, create an XmlSerializer using the XmlAttributeOverrides object and call the Serialize or Deserialize method.

The following example serializes a class named Group that contains a property named GroupName; the GroupName property is serialized as an XML attribute. The example creates an XmlAttributeOverrides and an XmlAttributes object to override the default serialization of the field. The example then creates an XmlAttributeAttribute to specifically override the property, and the object is set to the XmlAttribute property The XmlAttributes object is added to the XmlAttributeOverrides object with the name of the overridden member specified. Finally, an XmlSerializer is constructed and returned using the XmlAttributeOverrides object.

#using <System.Xml.dll>
#using <System.dll>

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

// This is the class that will be serialized.
public ref class Group

   // This is the attribute that will be overridden.

   String^ GroupName;
   int GroupNumber;

// Return an XmlSerializer used for overriding. 
XmlSerializer^ CreateOverrider()
   // Create the XmlAttributeOverrides and XmlAttributes objects.
   XmlAttributeOverrides^ xOver = gcnew XmlAttributeOverrides;
   XmlAttributes^ xAttrs = gcnew XmlAttributes;

   /* Create an overriding XmlAttributeAttribute set it to 
      the XmlAttribute property of the XmlAttributes object.*/
   XmlAttributeAttribute^ xAttribute = gcnew XmlAttributeAttribute( "SplinterName" );
   xAttrs->XmlAttribute = xAttribute;

   // Add to the XmlAttributeOverrides. Specify the member name.
   xOver->Add( Group::typeid, "GroupName", xAttrs );

   // Create the XmlSerializer and return it.
   return gcnew XmlSerializer( Group::typeid,xOver );

void SerializeObject( String^ filename )
   // Create an instance of the XmlSerializer class.
   XmlSerializer^ mySerializer = CreateOverrider();

   // Writing the file requires a TextWriter.
   TextWriter^ writer = gcnew StreamWriter( filename );

   // Create an instance of the class that will be serialized.
   Group^ myGroup = gcnew Group;

   /* Set the Name property, which will be generated 
      as an XML attribute. */
   myGroup->GroupName = ".NET";
   myGroup->GroupNumber = 1;

   // Serialize the class, and close the TextWriter.
   mySerializer->Serialize( writer, myGroup );

void DeserializeObject( String^ filename )
   XmlSerializer^ mySerializer = CreateOverrider();
   FileStream^ fs = gcnew FileStream( filename,FileMode::Open );
   Group^ myGroup = dynamic_cast<Group^>(mySerializer->Deserialize( fs ));
   Console::WriteLine( myGroup->GroupName );
   Console::WriteLine( myGroup->GroupNumber );

int main()
   SerializeObject( "OverrideAttribute.xml" );
   DeserializeObject( "OverrideAttribute.xml" );

Universal Windows Platform
Available since 8
.NET Framework
Available since 1.1
Portable Class Library
Supported in: portable .NET platforms
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1
Return to top