The code provided her is to use XML files as a storage for data (fast).
It is useful to use like the .NET Framework
appSettings class, but devoted to the compact framework. It is 100% compatible and very lightweight (compared to SQLCE). It solves the problem of storing data permanently in any CFNet device, related to an application -not only settings-, so you can use this class to store other kinds of data in the client Windows Mobile smartdevice.
This is easily portable to C# This code -for VB.NET- create an XML file if no one's present. It's very easy to use in less than a minute because you have a default XML settings file that is on a string variable that you can easily customize (inside #MyAppSetting.vb). With that class, you can create/store, load and update data through XML. You can add all the 'data fields' that your application requires and manage in simple 1 or 2 ways:
- Fast: Writing that data fields required directly on the variable string that contains the XML as text (inside #MyAppSetting.vb)
- With integrated intellisense: just by writing 1 property per data or setting you need, as exposed below:
Public Property YourRequiredData() As TypeNeeded
Set(ByVal value As TypeNeeded)
Using the code
It is very simple to use, and it is well documented (I think). Just add the class MyAppSetting.vb to your project, then:
Dim MyAppSettings As New MyAppSettings
To the above instance, you can pass an optionally args; Path string and a FileName string to look for/create (look at the supplied code for more info). If the class did not find any XML file, then automatically create one, just ready to use. What? The default
XmlDefaultConfig.... In the class there a
var that holds the default XML configuration that you can customize (all custom code inside
appSettings tab, respecting the format):
Private XmlDefaultConfigurationFileString As String = _
" ="" ="" " & _
"<configuration>" & _
"<appSettings>" & _
"<add key=""FileCreated"" value=""" & Now & """ />" & _
"<add key=""FileModified"" value="""" />" & _
"<add key=""UserName"" value="""" />" & _
"<add key=""LoginCount"" value=""0"" />" & _
"</appSettings>" & _
Now you can load data anywhere:
Dim YourRequiredData As AnyType = MyAppSettings.YourRequiredData Dim YourRequiredDataWithoutTypeAnyProp As AnyType = _
You can save by doing:
MyAppSettings.YourRequiredData = "new data to store .."
MyAppSettings.ListItems("YourRequiredDataWithoutTypeAnyProp") = Now.today MyAppSettings.SaveXmlCurrentConfiguration()
Points of Interest
I write 3 different methods to save the XML default file (that you could implement for update or save in another method). They are in the following
StreamWrite = 1 XmlTextWriter = 2 XmlDocument = 3
Private XmlSaveMethod As enumXmlSaveMethod = enumXmlSaveMethod.XmlDocument
You can try the 3 just by changing the last assign.
All that remains is to apply the 3 different methods to save -if you want- for the:
Public Function SaveXmlCurrentConfiguration_
(Optional ByVal StrPath As String = Nothing, _
Optional ByVal StrFilename As String = "AppSettings.xml")
now only applies to:
Public Function SaveXmlDefaultConfigurationFile(ByVal FilePath As String, _
Optional ByVal XmlConfigurationFileString As String = Nothing) As Boolean
I only applied to one
sub for build and show less code to allow the developer to see and choose.
This is my first entry that I built for the CodeProject community, around 4 hours including testing, plus near 2 hours to document and upload. I'll write that code -based on others including pbrroks at SaveSettings.aspx, and Microsoft at http://msdn.microsoft.com/en-us/library/aa446526.aspx, ..-, to get our mobile project work fast with
I hope you like it. - Please post any bugs if you troubleshoot!
Alejandro B. Martin
- 13th January, 2010: Initial post