Control XML Serialization format with a specific method

Question

I have a DateTime and a subclass that I want formatted specifically on XML serialization. Normally, without specifying anything, serialization of a DateTime would just follow the current culture, but I want DateTime formatted in a certain way (even if not deserializable), ditto the subclass.

So, given these classes:

public class MyClass
{
    public DateTime MyDateTime { get; set; }
    public MySubClass TheSubClass { get; set; }
}

public class MySubClass 
{
    public int ID { get; set; }
    public string Name { get; set; }
}

How do I specify serialization methods that would output:

<MyClass>
  <MyDateTime>2011-9-13T10:30:00Z</MyDateTime>
  <MySubClass>ID-Name</MySubClass>
</MyClass>

luksan · Accepted Answer · 2011-09-13 15:48:33Z

2

Are you utilizing XmlSerializer? If so, you do not need to include the [Serializable] attributes, they are ignored by XmlSerializer. You can customize the serialization by implementing the IXmlSerializable interface on your type.

http://msdn.microsoft.com/en-us/library/system.xml.serialization.ixmlserializable.aspx

answered Sep 13, 2011 at 15:48

luksan

7,8173 gold badges40 silver badges38 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

MPelletier Over a year ago

Bad habit of mine, I always think [Serializable] is required. Thanks.

IAbstract · Accepted Answer · 2012-08-02 13:43:53Z

2

This is off the top of my head ...I haven't nested a type in Xml serialization as you have - but this should be close.

[XmlRoot]
public class MyClass
{
    [XmlElement]
    public DateTime MyDateTime { get; set; }
    [XmlElement]
    public MySubClass TheSubClass { get; set; }
}

[XmlRoot]
public class MySubClass 
{
    [XmlElement]
    public int ID { get; set; }
    [XmlIgnore]  // since you didn't include in XML snippet
    public string Name { get; set; }
}

If you are performing simple Xml serialization: check MSDN XmlSerializer.

Update

I missed I want DateTime formatted in a certain way ...what I've done is the following rather than implementing IXmlSerializable:

[XmlRoot]
public class MyClass
{
    [XmlElement]
    public string MyDateTime { get; set; }
    [XmlIgnore]
    public DateTime DT
    {
        get { /* return DateTime from MyDateTime */ }
        set { MyDateTime = value.ToString( /* use formatting */); } // ex. ToString("yyyy, MMMM dd : hh:mm")
    }
    [XmlElement]
    public MySubClass TheSubClass { get; set; }
}

edited Aug 2, 2012 at 13:43

answered Sep 13, 2011 at 15:57

IAbstract

19.9k17 gold badges104 silver badges153 bronze badges

4 Comments

MPelletier Over a year ago

Thanks. For Name it's actually part of the element, ID-Name in the MySubClass tag, but I got that figured out with luksan's answer.

Beygi Over a year ago

@IAbstract [XmlElement] public class MySubClass results "Attribute 'XmlElement' is not valid on this declaration type. It is only valid on 'property, indexer, field, param, return' declarations."

IAbstract Over a year ago

@Beygi: In reference to the first example? I'll review ...but at first glance, you are correct.

Beygi Over a year ago

Thanks for edit and good answer... i did +1 before, for this helpful post

Collectives™ on Stack Overflow

Control XML Serialization format with a specific method

2 Answers 2

1 Comment

4 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

1 Comment

4 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related