How to serialize deserialize to Dictionary int string from custom XML not using XElement

Question

Having empty Dictionary lt int  string gt  how to fill it with keys and values from XML like    lt items gt   lt item id  int goes here  value  string goes here   gt   lt  items gt    and serialize it back into XML not using XElement

User · Answer

You can use ExtendedXmlSerializer   If you have a class   public class TestClass       public Dictionary lt int  string gt  Dictionary   get  set        and create instance of this class   var obj   new TestClass       Dictionary   new Dictionary lt int  string gt                 1   First             2   Second             3   Other               You can serialize this object using ExtendedXmlSerializer   var serializer   new ConfigurationContainer        UseOptimizedNamespaces     If you want to have all namespaces in root element      Create     var xml   serializer Serialize      new XmlWriterSettings   Indent   true      If you want to formated xml     obj     Output xml will look like    lt  xml version  1 0  encoding  utf-8   gt   lt TestClass xmlns sys  https   extendedxmlserializer github io system  xmlns exs  https   extendedxmlserializer github io v2  xmlns  clr-namespace ExtendedXmlSerializer Samples assembly ExtendedXmlSerializer Samples  gt     lt Dictionary gt       lt sys Item gt         lt Key gt 1 lt  Key gt         lt Value gt First lt  Value gt       lt  sys Item gt       lt sys Item gt         lt Key gt 2 lt  Key gt         lt Value gt Second lt  Value gt       lt  sys Item gt       lt sys Item gt         lt Key gt 3 lt  Key gt         lt Value gt Other lt  Value gt       lt  sys Item gt     lt  Dictionary gt   lt  TestClass gt    You can install ExtendedXmlSerializer from nuget or run the following command   Install-Package ExtendedXmlSerializer

User · Answer

I use serializable classes for the WCF communication between different modules  Below is an example of serializable class which serves as DataContract as well  My approach is to use the power of LINQ to convert the Dictionary into out-of-the-box serializable List lt   of KeyValuePair lt         using System      using System Collections Generic      using System Linq      using System Runtime Serialization      using System Xml Serialization       namespace MyFirm Common Data                DataContract           Serializable          public class SerializableClassX                          since the Dictionary lt  gt  class is not serializable                 we convert it to the List lt KeyValuePair lt  gt  gt               XmlIgnore              public Dictionary lt string  int gt  DictionaryX                                get                                       return  SerializableList    null                                null                               SerializableList ToDictionary item   gt  item Key  item   gt  item Value                                      set                                       SerializableList    value    null                                           null                                           value ToList                                                  DataMember               XmlArray  SerializableList                 XmlArrayItem  Pair                public List lt KeyValuePair lt string  int gt  gt  SerializableList   get  set                      The usage is straightforward - I assign a dictionary to my data object s dictionary field - DictionaryX  The serialization is supported inside the SerializableClassX by conversion of the assigned dictionary into the serializable List lt   of KeyValuePair lt            create my data object     SerializableClassX SerializableObj   new SerializableClassX param           this will call the DictionaryX set and convert the          new Dictionary into SerializableList     SerializableObj DictionaryX   new Dictionary lt string  int gt                  Key1   1             Key2   2

User · Answer

I have a struct KeyValuePairSerializable    Serializable  public struct KeyValuePairSerializable lt K  V gt        public KeyValuePairSerializable KeyValuePair lt K  V gt  pair                Key   pair Key          Value   pair Value              XmlAttribute      public K Key   get  set          XmlText      public V Value   get  set         public override string ToString                 return       StringHelper ToString Key               StringHelper ToString Value                       Then  the XML serialization of a Dictionary property is by    XmlIgnore  public Dictionary lt string  string gt  Parameters   get  set      XmlArray  Parameters     XmlArrayItem  Pair     DebuggerBrowsable DebuggerBrowsableState Never      not necessary public KeyValuePairSerializable lt string  string gt    ParametersXml       get                 return Parameters  Select p   gt  new KeyValuePairSerializable lt string  string gt  p   ToArray               set               Parameters   value  ToDictionary i   gt  i Key  i   gt  i Value             Just the property must be the array  not the List

User · Answer

Dictionaries are not Serializable in C  by default  I don t know why  but it seems to have been a design choice   Right now  I d recommend using Json NET to convert it to JSON and from there into a dictionary  and vice versa   Unless you really need the XML  I d recommend using JSON completely

User · Answer

With the help of a temporary item class  public class item        XmlAttribute      public int id       XmlAttribute      public string value      Sample Dictionary   Dictionary lt int  string gt  dict   new Dictionary lt int  string gt           1  one     2  two           XmlSerializer serializer   new XmlSerializer typeof item                                       new XmlRootAttribute     ElementName    items        Serialization  serializer Serialize stream                 dict Select kv  gt new item   id   kv Key value kv Value   ToArray        Deserialization  var orgDict     item   serializer Deserialize stream                   ToDictionary i   gt  i id  i   gt  i value     ------------------------------------------------------------------------------  Here is how it can be done using XElement  if you change your mind   Serialization  XElement xElem   new XElement                       items                       dict Select x   gt  new XElement  item  new XAttribute  id   x Key  new XAttribute  value   x Value                        var xml   xElem ToString      xElem Save         Deserialization  XElement xElem2   XElement Parse xml     XElement Load      var newDict   xElem2 Descendants  item                        ToDictionary x   gt   int x Attribute  id    x   gt   string x Attribute  value

User · Answer

Paul Welter s ASP NET blog has a dictionary that is serializeable  But it does not use attributes  I will explain why below the code   using System  using System Collections Generic  using System Text  using System Xml Serialization    XmlRoot  dictionary    public class SerializableDictionary lt TKey  TValue gt        Dictionary lt TKey  TValue gt   IXmlSerializable        region IXmlSerializable Members     public System Xml Schema XmlSchema GetSchema                 return null             public void ReadXml System Xml XmlReader reader                XmlSerializer keySerializer   new XmlSerializer typeof TKey            XmlSerializer valueSerializer   new XmlSerializer typeof TValue             bool wasEmpty   reader IsEmptyElement          reader Read             if  wasEmpty              return           while  reader NodeType    System Xml XmlNodeType EndElement                        reader ReadStartElement  item                 reader ReadStartElement  key                TKey key    TKey keySerializer Deserialize reader               reader ReadEndElement                 reader ReadStartElement  value                TValue value    TValue valueSerializer Deserialize reader               reader ReadEndElement                 this Add key  value                reader ReadEndElement                reader MoveToContent                      reader ReadEndElement               public void WriteXml System Xml XmlWriter writer                XmlSerializer keySerializer   new XmlSerializer typeof TKey            XmlSerializer valueSerializer   new XmlSerializer typeof TValue             foreach  TKey key in this Keys                        writer WriteStartElement  item                 writer WriteStartElement  key                keySerializer Serialize writer  key               writer WriteEndElement                 writer WriteStartElement  value                TValue value   this key               valueSerializer Serialize writer  value               writer WriteEndElement                 writer WriteEndElement                         endregion     First  there is one gotcha with this code  Say you read a dictionary from another source that has this    lt dictionary gt     lt item gt       lt key gt         lt string gt key1 lt  string gt       lt  key gt       lt value gt         lt string gt value1 lt  string gt       lt  value gt     lt  item gt     lt item gt       lt key gt         lt string gt key1 lt  string gt       lt  key gt       lt value gt         lt string gt value2 lt  string gt       lt  value gt     lt  item gt   lt  dictionary gt    This will throw a exception on de-seariazation because you can only have one key for a dictionary     The reason you MUST use a XElement in a seriazed dictionary is dictionary is not defined as Dictionary lt String String gt   a dictionary is Dictionary lt TKey TValue gt    To see the problem  ask your self  Lets say we have a TValue that serializes in to something that uses Elements it describes itself as XML  lets say a dictionary of dictionaries Dictionary lt int Dictionary lt int string gt  gt   not that uncommon of a pattern  it s a lookup table    how would your Attribute only version represent a dictionary entirely inside a attribute

User · Answer

Write a class A  that contains of an array of class B  Class B should have an id property and a value property  Deserialize the xml to class A  Convert the array in A to the wanted dictionary    To serialize the dictionary convert it to an instance of class A  and serialize

User · Answer

There is an easy way with Sharpeserializer  open source      http   www sharpserializer com   It can directly serialize de-serialize dictionary   There is no need to mark your object with any attribute  nor do you have to give the object type in the Serialize method  See here      To install via nuget   Install-package sharpserializer  Then it is very simple    Hello World  from the official website       create fake obj var obj   createFakeObject        create instance of sharpSerializer    with standard constructor it serializes to xml var serializer   new SharpSerializer        serialize serializer Serialize obj   test xml        deserialize var obj2   serializer Deserialize  test xml

User · Answer

KeyedCollection works like dictionary and is serializable   First create a class containing key and value        lt summary gt      simple class      lt  summary gt       lt remarks gt  lt  remarks gt   Serializable    public class cCulture            lt summary gt          culture          lt  summary gt      public string culture            lt summary gt          word list          lt  summary gt      public List lt string gt  list            lt summary gt          status          lt  summary gt      public string status      then create a class of type KeyedCollection  and define a property of your class as key        lt summary gt      keyed collection       lt  summary gt       lt remarks gt  lt  remarks gt   Serializable    public class cCultures   System Collections ObjectModel KeyedCollection lt string  cCulture gt        protected override string GetKeyForItem cCulture item                return item culture            Usefull to serialize such type of datas

User · Answer

Based on L B  s answer   Usage   var serializer   new DictionarySerializer lt string  string gt     serializer Serialize  dictionary xml    dictionary    dictionary    titleDictSerializer Deserialize  dictionary xml      Generic class   public class DictionarySerializer lt TKey  TValue gt         XmlType TypeName    Item        public class Item                XmlAttribute  key            public TKey Key           XmlAttribute  value            public TValue Value             private XmlSerializer  serializer   new XmlSerializer typeof Item     new XmlRootAttribute  Dictionary          public Dictionary lt TKey  TValue gt  Deserialize string filename                using  FileStream stream   new FileStream filename  FileMode Open           using  XmlReader reader   XmlReader Create stream                         return   Item    serializer Deserialize reader   ToDictionary p   gt  p Key  p   gt  p Value                        public void Serialize string filename  Dictionary lt TKey  TValue gt  dictionary                using  var writer   new StreamWriter filename                          serializer Serialize writer  dictionary Select p   gt  new Item     Key   p Key  Value   p Value    ToArray

[c#] How to serialize/deserialize to `Dictionary<int, string>` from custom XML not using XElement?

Examples related to c#

Examples related to .net

Examples related to xml

Examples related to mono