Export (0) Print
Expand All

XmlEnumAttribute Constructor

Initializes a new instance of the XmlEnumAttribute class.

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

public XmlEnumAttribute()

You can use the XmlEnumAttribute to override an existing enumeration.

NoteNote:

You can use the word XmlEnum in your code instead of the longer XmlEnumAttribute.

The following example serializes two classes named Food and FoodType. The FoodType class contains two enumerations that are overridden and, for each enumeration, the example creates an XmlEnumAttribute object that is assigned to the XmlEnum property of an XmlAttributes object. The example then adds the XmlAttributes object to an XmlAttributeOverrides object, which is used to create an XmlSerializer.

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

// This is the class that will be serialized. 
public class Food
{
   public FoodType Type;
}

public enum FoodType
{
   // Subsequent code overrides these enumerations.
   Low,
   High
}



public class Run
{
   public static void Main()
   {
      Run test = new Run();
      test.SerializeObject("OverrideEnum.xml");
      test.DeserializeObject("OverrideEnum.xml");
   }

   // Return an XmlSerializer used for overriding.  
   public XmlSerializer CreateOverrider()
   {
      // Create the XmlOverrides and XmlAttributes objects.
      XmlAttributeOverrides xOver = new XmlAttributeOverrides();
      XmlAttributes xAttrs = new XmlAttributes();

      // Add an XmlEnumAttribute for the FoodType.Low enumeration.
      XmlEnumAttribute xEnum = new XmlEnumAttribute();
      xEnum.Name = "Cold";
      xAttrs.XmlEnum = xEnum;
      xOver.Add(typeof(FoodType), "Low", xAttrs);

      // Add an XmlEnumAttribute for the FoodType.High enumeration.
      xAttrs = new XmlAttributes();
      xEnum = new XmlEnumAttribute();
      xEnum.Name = "Hot";
      xAttrs.XmlEnum = xEnum;
      xOver.Add(typeof(FoodType), "High", xAttrs);

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


   public void SerializeObject(string filename)
   {
      // Create an instance of the XmlSerializer class.
      XmlSerializer mySerializer =  CreateOverrider();
      // Writing the file requires a TextWriter.
      TextWriter writer = new StreamWriter(filename);

      // Create an instance of the class that will be serialized.
      Food myFood = new Food();

      // Set the object properties.
      myFood.Type = FoodType.High;

      // Serialize the class, and close the TextWriter.
      mySerializer.Serialize(writer, myFood);
      writer.Close();
   }

   public void DeserializeObject(string filename)
   {
      XmlSerializer mySerializer = CreateOverrider();
      FileStream fs = new FileStream(filename, FileMode.Open);
      Food myFood = (Food) 
      mySerializer.Deserialize(fs);

      Console.WriteLine(myFood.Type);
   }
}
#using <mscorlib.dll>
#using <System.Xml.dll>
using namespace System;
using namespace System::IO;
using namespace System::Xml;
using namespace System::Xml::Serialization;

public __value enum FoodType
{
   // Subsequent code overrides these enumerations.
   Low,
   High
};

// This is the class that will be serialized.
public __gc class Food
{
public:
   FoodType Type;
};

   // Return an XmlSerializer used for overriding. 
   XmlSerializer* CreateOverrider()
   {
      // Create the XmlOverrides and XmlAttributes objects.
      XmlAttributeOverrides* xOver = new XmlAttributeOverrides();
      XmlAttributes* xAttrs = new XmlAttributes();

      // Add an XmlEnumAttribute for the FoodType.Low enumeration.
      XmlEnumAttribute* xEnum = new XmlEnumAttribute();
      xEnum->Name = S"Cold";
      xAttrs->XmlEnum = xEnum;
      xOver->Add(__typeof(FoodType), S"Low", xAttrs);

      // Add an XmlEnumAttribute for the FoodType.High enumeration.
      xAttrs = new XmlAttributes();
      xEnum = new XmlEnumAttribute();
      xEnum->Name = S"Hot";
      xAttrs->XmlEnum = xEnum;
      xOver->Add(__typeof(FoodType), S"High", xAttrs);

      // Create the XmlSerializer, and return it.
      return new XmlSerializer(__typeof(Food), xOver);
   }

   void SerializeObject(String* filename)
   {
      // Create an instance of the XmlSerializer class.
      XmlSerializer* mySerializer =  CreateOverrider();
      // Writing the file requires a TextWriter.
      TextWriter* writer = new StreamWriter(filename);

      // Create an instance of the class that will be serialized.
      Food* myFood = new Food();

      // Set the object properties.
      myFood->Type = FoodType::High;

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

   void DeserializeObject(String* filename)
   {
      XmlSerializer* mySerializer = CreateOverrider();
      FileStream* fs = new FileStream(filename, FileMode::Open);
      Food* myFood = dynamic_cast<Food*>(mySerializer->Deserialize(fs));

      Console::WriteLine(__box(myFood->Type));
   }

   int main()
   {
      SerializeObject(S"OverrideEnum.xml");
      DeserializeObject(S"OverrideEnum.xml");
   }

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune

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

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 3.5, 2.0, 1.0

XNA Framework

Supported in: 3.0, 2.0, 1.0

Community Additions

ADD
Show:
© 2014 Microsoft