Export (0) Print
Expand All

XmlAttributes.XmlIgnore Property

Gets or sets a value that specifies whether or not the XmlSerializer serializes a public field or public read/write property.

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

public bool XmlIgnore { get; set; }

Property Value

Type: System.Boolean
true if the XmlSerializer must not serialize the field or property; otherwise, false.

By default, all public fields and public read/write properties are serialized by the XmlSerializer. That is, the value of each public field or property is persisted as an XML element or XML attribute in an XML-document instance.

To override the default serialization of a field or property, create an XmlAttributes object, and set its XmlIgnore property to true. Add the object to an XmlAttributeOverrides object and specify the type of the object that contains the field or property to ignore, and the name of the field or property to ignore.

If an XmlIgnoreAttribute is applied to a field or property, the field or property is ignored. However you can override that behavior by creating an XmlAttributes object, setting its XmlIgnore property to false, adding it to an XmlAttributeOverrides object specifying the type of the object that contains the field or property, and the name of the field or property.

The following example serializes a class named Group, which contains a member named Comment to which the XmlIgnoreAttribute is applied. The example creates an XmlAttributes object, and sets the XmlIgnore property to false, thereby overriding the XmlIgnoreAttribute.

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

// This is the class that will be serialized.  
public class Group
{
   // The GroupName value will be serialized--unless it's overridden. 
   public string GroupName;

   /* This field will be ignored when serialized--
      unless it's overridden. */
   [XmlIgnoreAttribute]
   public string Comment;
}

public class Test
{
   public static void Main()
   {
      Test t = new Test();
      t.SerializeObject("IgnoreXml.xml");
   }

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

      /* Setting XmlIgnore to false overrides the XmlIgnoreAttribute
         applied to the Comment field. Thus it will be serialized.*/
      attrs.XmlIgnore = false;
      xOver.Add(typeof(Group), "Comment", attrs);

      /* Use the XmlIgnore to instruct the XmlSerializer to ignore
         the GroupName instead. */
      attrs = new XmlAttributes();
      attrs.XmlIgnore = true;
      xOver.Add(typeof(Group), "GroupName", attrs);

      XmlSerializer xSer = new XmlSerializer(typeof(Group), xOver);
      return xSer;
   }

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

      // Create the object to serialize and set its properties.
      Group myGroup = new Group();
      myGroup.GroupName = ".NET";
      myGroup.Comment = "My Comment...";

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

      // Serialize the object and close the TextWriter.
      xSer.Serialize(writer, myGroup);
      writer.Close();
   }
}
#using <mscorlib.dll>
#using <System.Xml.dll>
#using <System.dll>
using namespace System;
using namespace System::IO;
using namespace System::Xml::Serialization;

// This is the class that will be serialized. 
public __gc class Group
{
public:
   // The GroupName value will be serialized--unless it's overridden.
   String* GroupName;

   /* This field will be ignored when serialized--
   unless it's overridden. */
   [XmlIgnoreAttribute]
   String* Comment;
};

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

   /* Setting XmlIgnore to false overrides the XmlIgnoreAttribute
   applied to the Comment field. Thus it will be serialized.*/
   attrs->XmlIgnore = false;
   xOver->Add(__typeof(Group), S"Comment", attrs);

   /* Use the XmlIgnore to instruct the XmlSerializer to ignore
   the GroupName instead. */
   attrs = new XmlAttributes();
   attrs->XmlIgnore = true;
   xOver->Add(__typeof(Group), S"GroupName", attrs);

   XmlSerializer* xSer = new XmlSerializer(__typeof(Group), xOver);
   return xSer;
}

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

   // Create the object to serialize and set its properties.
   Group* myGroup = new Group();
   myGroup->GroupName = S".NET";
   myGroup->Comment = S"My Comment...";

   // Writing the file requires a TextWriter.
   TextWriter* writer = new StreamWriter(filename);

   // Serialize the object and close the TextWriter.
   xSer->Serialize(writer, myGroup);
   writer->Close();
}

int main()
{
   SerializeObject(S"IgnoreXml.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

XNA Framework

Supported in: 3.0, 2.0, 1.0

Community Additions

ADD
Show:
© 2014 Microsoft