Read / write settings to config (xml) file.

Read / write settings to config (xml) file. Read/writesettingstoconfig(xml)file. Read / write settings to config (xml) file. [C#] Robert Wagner /PreviewSnippet.aspx?SnippetID=df5fef05-28ff-4e15-acc7-00b31b32c5d1 SurroundsWith

			
				
				
			
			
	
	Default settings file name is the same as app.config, 
	appends .config to the end of the assembly name. Example:
	
		.config.
*/

using System;
using System.Collections;
using System.Reflection;
using System.Xml;
using System.IO;

namespace SmartClient
{
	/// 
	/// Read / write app.config settings file.
	/// 
	public class Settings
	{
		// internal fields
		Hashtable m_list = new Hashtable();
		string m_filePath = string.Empty;
		bool m_autoWrite = true;
		string[,] m_defaultValues;

		// properties
		
		/// 
		/// Specifies if the settings file is updated whenever a value 
		/// is set. If false, you need to call Write to update the 
		/// underlying settings file.
		/// 
		public bool AutoWrite
		{
			get { return m_autoWrite; }
			set { m_autoWrite = value; }
		}
		
		/// 
		/// Full path to settings file.
		/// 
		public string FilePath
		{
			get { return m_filePath; }
			set { m_filePath = value; }
		}

		/// 
		/// Default constructor. 
		/// 
		public Settings()
		{
			// get full path to file
			m_filePath = GetFilePath();
			
			// populate list with settings from file
			Read();
		}

		/// 
		/// Constructor. Pass in an array of default values.
		/// Sample usage that passes in default values:
		///
		///		string[,] values = 
		///		{
		///			{"Name", "Live Oak"},
		///			{"LogEvents", "True"}
		///		}
		///
		///		Settings settings = new Settings(values);
		///
		/// 
		public Settings(string[,] defaultValues)
		{
			// store default values, use later when populate list
			m_defaultValues = defaultValues;

			// get full path to file
			m_filePath = GetFilePath();

			// populate list with settings from file
			Read();
		}
		

		// public methods
		
		/// 
		/// Set setting value. Update underlying file if AutoUpdate is true.
		/// 
		public void SetValue(string key, object value)
		{
			// update internal list
			m_list[key] = value;
			
			// update settings file
			if (m_autoWrite)
				Write();
		}

		/// 
		/// Return specified settings as string.
		/// 
		public string GetString(string key)
		{
			object result = m_list[key];
			return (result == null) ? String.Empty : result.ToString();
		}
		
		/// 
		/// Return specified settings as integer.
		/// 
		public int GetInt(string key)
		{
			string result = GetString(key);
			return (result == String.Empty) ? 0 : Convert.ToInt32(result);
		}

		/// 
		/// Return specified settings as boolean.
		/// 
		public bool GetBool(string key)
		{
			string result = GetString(key);
			return (result == String.Empty) ? false : Convert.ToBoolean(result);
		}
		
		/// 
		/// Read settings file.
		/// 
		public void Read()
		{
			try
			{
				// first remove all items from list
				m_list.Clear();
				
				// next, populate list with default values
				for (int i=0; i < m_defaultValues.GetLength(0); i++)
					m_list[m_defaultValues[i,0]] = m_defaultValues[i,1];
			
				// last, populate list with items from file
			
				// open settings file
				XmlTextReader reader = new XmlTextReader(m_filePath);

				// go through file and read the xml file and 
				// populate internal list with 'add' elements
				while (reader.Read())
				{
					if ((reader.NodeType == XmlNodeType.Element) && (reader.Name == "add"))
						m_list[reader.GetAttribute("key")] = reader.GetAttribute("value");
				}
				reader.Close();
			}
			catch (Exception ex)
			{
				System.Diagnostics.Debug.WriteLine(ex.Message);
			}
		}
		
		/// 
		/// Write settings to file.
		/// 
		public void Write()
		{
			try
			{
				// header elements
				StreamWriter writer = File.CreateText(m_filePath);
				writer.WriteLine("");
				writer.WriteLine("\t");

				// go through internal list and create 'add' element for each item
				IDictionaryEnumerator enumerator = m_list.GetEnumerator();
				while (enumerator.MoveNext())
				{
					writer.WriteLine("\t\t",
						enumerator.Key.ToString(),
						enumerator.Value);
				}

				// footer elements
				writer.WriteLine("\t");
				writer.WriteLine("");

				writer.Close();
			}
			catch (Exception ex)
			{
				System.Diagnostics.Debug.WriteLine(ex.Message);
			}
		}

		public void RestoreDefaults()
		{
			try
			{
				// easiest way is to delete the file and
				// repopulate internal list with defaults
				File.Delete(FilePath);
				Read();
			}
			catch (Exception ex)
			{
				System.Diagnostics.Debug.WriteLine(ex.Message);
			}
		}


		//
		// private methods
		//
		
		/// 
		/// Return full path to settings file. Appends .config to the assembly name.
		/// 
		private string GetFilePath()
		{
			return Assembly.GetExecutingAssembly().GetName().CodeBase + ".config";
		}
	}
}
]]>