Override XML Serialization Method

Question

I'm having trouble trying to customize the way DateTime variables are serialized in my objects. I want it to be output as 2011-09-26T13:00:00Z but when I override the GetObjectData() function as I believe is the way to do this, no XML data is output for them at all.

    [DataContract(Namespace = "")]
    [XmlRootAttribute(Namespace = "http://www.w3.org/2005/Atom", ElementName = "feed")]
    public class GCal
    {
            [XmlNamespaceDeclarations]
            public XmlSerializerNamespaces _xsns = new XmlSerializerNamespaces();

            [XmlElement(ElementName = "entry")]
            public Collection<MMU.Calendar.gCalEvent> items = new Collection<MMU.Calendar.gCalEvent>();

/*some other elements*/
    }

    public class gCalEvent
    {
            [XmlElement(Namespace = "http://schemas.google.com/g/2005")]
            public gdEvent when = new gdEvent();

/*some other elements*/
    }

    public class gdEvent : ISerializable
    {
            [XmlAttribute(AttributeName = "startTime")]
            private DateTime _startTime; 
            [XmlAttribute(AttributeName = "endTime")]
            private DateTime _endTime;

            public gdEvent(DateTime startTime, DateTime endTime)
            {
                    _startTime = startTime;
                    _endTime = endTime;
            }

            public gdEvent()
            {
                    _startTime = DateTime.MinValue;
                    _endTime = DateTime.MinValue;
            }
            [SecurityPermissionAttribute(SecurityAction.Demand, SerializationFormatter = true)]
            public virtual void GetObjectData(SerializationInfo info, StreamingContext context)
            {
                    //needs to be in the format 2011-09-26T13:00:00Z
                    //if (_startTime != DateTime.MinValue)
                    info.AddValue("startTime", _startTime.ToString("yyyy-MM-ddTHH:mm:ssZ");
                    //if (_endTime != DateTime.MinValue)
                    info.AddValue("endTime", _endTime.ToString("yyyy-MM-ddTHH:mm:ssZ"));
            }
    }

    GCal calendar = new GCal();
    calendar = readSwsSpreadsheet(urlToCall);
    stream = new MemoryStream();
    XmlSerializer serializer = new XmlSerializer(typeof(GCal));
    serializer.Serialize(stream, calendar);
    stream.Seek(0, SeekOrigin.Begin);
    Stream results = new MemoryStream();
    WebOperationContext.Current.OutgoingResponse.ContentType = "text/xml";
    return stream;

I have tried to look this info up but there seems to be a lot about custom serializing to files but not to XML...

score 8 · Answer 1 · answered Mar 08 '12 at 14:26

You're trying to customize standard serialization (ISerializable) for a property type whose containing type is being serialized with XmlSerializer. You need implement the IXmlSerializable interface to customize XML Serialization. Try something like this:

public class gdEvent : IXmlSerializable
{
    private DateTime _startTime;
    private DateTime _endTime;

    public gdEvent(DateTime startTime, DateTime endTime)
    {
        _startTime = startTime;
        _endTime = endTime;
    }

    public gdEvent()
    {
        _startTime = DateTime.MinValue;
        _endTime = DateTime.MinValue;
    }

    public XmlSchema GetSchema()
    {
        return null;
    }

    public void WriteXml(XmlWriter writer)
    {
        if (_startTime != DateTime.MinValue)
            writer.WriteAttributeString("startTime", _startTime.ToString("yyyy-MM-ddTHH:mm:ssZ"));
        if (_endTime != DateTime.MinValue)
            writer.WriteAttributeString("endTime", _endTime.ToString("yyyy-MM-ddTHH:mm:ssZ"));
    }

    public void ReadXml(XmlReader reader)
    {
        string startTimeString = reader.GetAttribute("startTime");
        if (!string.IsNullOrEmpty(startTimeString))
        {
            _startTime = DateTime.Parse(startTimeString);
        }
        string endTimeString = reader.GetAttribute("startTime");
        if (!string.IsNullOrEmpty(endTimeString))
        {
            _endTime = DateTime.Parse(endTimeString);
        }
    }

}

Thanks - I used a simpler method of formatting a the Datetime into string variable when it is set. But I wasn't aware of the IXMLSerializable class or how to use it... This will be very useful in the future :) — ankles, Mar 09 '12 at 16:36

score 2 · Accepted Answer · answered Mar 09 '12 at 16:35

I had a suggestion from @craighawker to format the DateTime into a string when calling a set() method for the DateTime. Seemed the simplest method although I would like to implement it the proper way using IXMLSerializable at some point in the future to do more powerful things

 public class gdEvent
    {
    [XmlAttribute(AttributeName = "startTime")]
    private string m_startTimeOutput;
    private DateTime m_startTime; //format 2011-11-02T09:00:00Z

    [XmlAttribute(AttributeName = "endTime")]
    private string m_endTimeOutput;
    private DateTime m_endTime; //2011-11-02T10:00:00Z

    public DateTime startTime
    {
        get
        {
        return m_startTime;
        }
        set
        {
        m_startTime = value;
        m_startTimeOutput = m_startTime.ToString("yyyy-MM-ddTHH:mm:ssZ");
        }
    }

    public DateTime endTime
    {
        get
        {
        return m_endTime;
        }
        set
        {
        m_endTime = value;
        m_endTimeOutput = m_endTime.ToString("yyyy-MM-ddTHH:mm:ssZ");
        }
    }

Override XML Serialization Method

2 Answers2

Linked