-
Notifications
You must be signed in to change notification settings - Fork 0
/
FormSerialisor.cs
203 lines (195 loc) · 9.35 KB
/
FormSerialisor.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
using System;
using System.IO;
using System.Windows.Forms;
using System.Reflection;
using System.Xml;
using System.Diagnostics;
namespace FormSerialisation
{
public static class FormSerialisor
{
/*
* Drop this class into your project, and add the following line at the top of any class/form that wishes to use it...
using FormSerialisation;
To use the code, simply call FormSerialisor.Serialise(FormOrControlToBeSerialised, FullPathToXMLFile)
*
* For more details, see http://www.codeproject.com/KB/dialog/SavingTheStateOfAForm.aspx
*
* Last updated 13th June '10 to account for the odd behaviour of the two Panel controls in a SplitContainer (see the article)
*
* (Unofficial) Update :
* Add Serialization and Deserialization of DateTimePicker
*/
public static void Serialise(Control c, string XmlFileName)
{
XmlTextWriter xmlSerialisedForm = new XmlTextWriter(XmlFileName, System.Text.Encoding.Default);
xmlSerialisedForm.Formatting = Formatting.Indented;
xmlSerialisedForm.WriteStartDocument();
xmlSerialisedForm.WriteStartElement("ChildForm");
// enumerate all controls on the form, and serialise them as appropriate
AddChildControls(xmlSerialisedForm, c);
xmlSerialisedForm.WriteEndElement(); // ChildForm
xmlSerialisedForm.WriteEndDocument();
xmlSerialisedForm.Flush();
xmlSerialisedForm.Close();
}
private static void AddChildControls(XmlTextWriter xmlSerialisedForm, Control c)
{
foreach (Control childCtrl in c.Controls)
{
if (!(childCtrl is Label))
{
// serialise this control
xmlSerialisedForm.WriteStartElement("Control");
xmlSerialisedForm.WriteAttributeString("Type", childCtrl.GetType().ToString());
xmlSerialisedForm.WriteAttributeString("Name", childCtrl.Name);
if (childCtrl is TextBox)
{
xmlSerialisedForm.WriteElementString("Text", ((TextBox)childCtrl).Text);
}
else if (childCtrl is ComboBox)
{
xmlSerialisedForm.WriteElementString("Text", ((ComboBox)childCtrl).Text);
xmlSerialisedForm.WriteElementString("SelectedIndex", ((ComboBox)childCtrl).SelectedIndex.ToString());
}
else if (childCtrl is ListBox)
{
// need to account for multiply selected items
ListBox lst = (ListBox)childCtrl;
if (lst.SelectedIndex == -1)
{
xmlSerialisedForm.WriteElementString("SelectedIndex", "-1");
}
else
{
for (int i = 0; i < lst.SelectedIndices.Count; i++)
{
xmlSerialisedForm.WriteElementString("SelectedIndex", (lst.SelectedIndices[i].ToString()));
}
}
}
else if (childCtrl is CheckBox)
{
xmlSerialisedForm.WriteElementString("Checked", ((CheckBox)childCtrl).Checked.ToString());
}
else if (childCtrl is DateTimePicker)
{
xmlSerialisedForm.WriteElementString("Text", ((DateTimePicker)childCtrl).Text);
}
// this next line was taken from http://stackoverflow.com/questions/391888/how-to-get-the-real-value-of-the-visible-property
// which dicusses the problem of child controls claiming to have Visible=false even when they haven't, based on the parent
// having Visible=true
bool visible = (bool)typeof(Control).GetMethod("GetState", BindingFlags.Instance | BindingFlags.NonPublic).Invoke(childCtrl, new object[] { 2 });
xmlSerialisedForm.WriteElementString("Visible", visible.ToString());
// see if this control has any children, and if so, serialise them
if (childCtrl.HasChildren)
{
if (childCtrl is SplitContainer)
{
// handle this one as a special case
AddChildControls(xmlSerialisedForm, ((SplitContainer)childCtrl).Panel1);
AddChildControls(xmlSerialisedForm, ((SplitContainer)childCtrl).Panel2);
}
else
{
AddChildControls(xmlSerialisedForm, childCtrl);
}
}
xmlSerialisedForm.WriteEndElement(); // Control
}
}
}
public static void Deserialise(Control c, string XmlFileName)
{
if (File.Exists(XmlFileName))
{
XmlDocument xmlSerialisedForm = new XmlDocument();
xmlSerialisedForm.Load(XmlFileName);
XmlNode topLevel = xmlSerialisedForm.ChildNodes[1];
foreach (XmlNode n in topLevel.ChildNodes)
{
SetControlProperties((Control)c, n);
}
}
}
private static void SetControlProperties(Control currentCtrl, XmlNode n)
{
// get the control's name and type
string controlName = n.Attributes["Name"].Value;
string controlType = n.Attributes["Type"].Value;
// find the control
Control[] ctrl = currentCtrl.Controls.Find(controlName, true);
if (ctrl.Length == 0)
{
// can't find the control
}
else
{
Control ctrlToSet = GetImmediateChildControl(ctrl, currentCtrl);
if (ctrlToSet != null)
{
if (ctrlToSet.GetType().ToString() == controlType)
{
// the right type too ;-)
switch (controlType)
{
case "System.Windows.Forms.TextBox":
((System.Windows.Forms.TextBox)ctrlToSet).Text = n["Text"].InnerText;
break;
case "System.Windows.Forms.ComboBox":
((System.Windows.Forms.ComboBox)ctrlToSet).Text = n["Text"].InnerText;
((System.Windows.Forms.ComboBox)ctrlToSet).SelectedIndex = Convert.ToInt32(n["SelectedIndex"].InnerText);
break;
case "System.Windows.Forms.ListBox":
// need to account for multiply selected items
ListBox lst = (ListBox)ctrlToSet;
XmlNodeList xnlSelectedIndex = n.SelectNodes("SelectedIndex");
for (int i = 0; i < xnlSelectedIndex.Count; i++)
{
lst.SelectedIndex = Convert.ToInt32(xnlSelectedIndex[i].InnerText);
}
break;
case "System.Windows.Forms.CheckBox":
((System.Windows.Forms.CheckBox)ctrlToSet).Checked = Convert.ToBoolean(n["Checked"].InnerText);
break;
case "System.Windows.Forms.DateTimePicker":
((System.Windows.Forms.DateTimePicker)ctrlToSet).Text = n["Text"].InnerText;
break;
}
ctrlToSet.Visible = Convert.ToBoolean(n["Visible"].InnerText);
// if n has any children that are controls, deserialise them as well
if (n.HasChildNodes && ctrlToSet.HasChildren)
{
XmlNodeList xnlControls = n.SelectNodes("Control");
foreach (XmlNode n2 in xnlControls)
{
SetControlProperties(ctrlToSet, n2);
}
}
}
else
{
// not the right type
}
}
else
{
// can't find a control whose parent is the current control
}
}
}
private static Control GetImmediateChildControl(Control[] ctrl, Control currentCtrl)
{
Control c = null;
for (int i = 0; i < ctrl.Length; i++)
{
if ((ctrl[i].Parent.Name == currentCtrl.Name) || (currentCtrl is SplitContainer && ctrl[i].Parent.Parent.Name == currentCtrl.Name))
{
c = ctrl[i];
break;
}
}
return c;
}
}
}