Click here to Skip to main content
15,886,199 members
Articles / Programming Languages / C#

DataStorage: Store settings type-safe

Rate me:
Please Sign up or sign in to vote.
4.50/5 (3 votes)
8 Aug 2012GPL33 min read 26.1K   234   9  
Shows how to use the DataStorage classes to generate type-safe settings classes.
using System;
using System.Collections.Generic;
using System.Text;

namespace pdfforge.DataStorage
{
    /// <summary>
    /// A builder class to create nicely formatted XML strings.
    /// 
    /// Current limitations:
    /// It does not support attributes.
    /// It requires you to enforce valid xml (i.e. names, only one root etc.)
    /// </summary>
    class XmlStringBuilder
    {
        private Stack<string> sections = new Stack<string>();
        private StringBuilder xml = new StringBuilder();
        private string indent = "";

        public XmlStringBuilder()
        {
            appendLine("<?xml version=\"1.0\" encoding=\"UTF-8\"?>");
        }

        /// <summary>
        /// Open a (sub) section to which values or subsections can be assigned later on.
        /// </summary>
        /// <param name="section">Name of the new subsection</param>
        public void openSubSection(string section)
        {
            appendLine("<" + section + " type=\"section\">");
            sections.Push(section);
            makeIndentString();
        }

        /// <summary>
        /// Closes a subsection
        /// </summary>
        public void closeSubSection()
        {
            if (sections.Count <= 0)
                return;

            string section = sections.Pop();
            makeIndentString();
            appendLine("</" + section + ">");
        }

        /// <summary>
        /// Adds a value to the current section
        /// </summary>
        /// <param name="name">name of the value</param>
        /// <param name="value">the actual value</param>
        public void addValue(string name, string value)
        {
            appendLine("<" + name + ">" + value + "</" + name + ">");
        }

        /// <summary>
        /// recalculates the indent string
        /// </summary>
        private void makeIndentString()
        {
            indent = "";
            for (int i = 0; i < sections.Count; i++)
            {
                indent += "\t";
            }
        }

        /// <summary>
        /// appends a line to the StringBuilder
        /// </summary>
        /// <param name="text"></param>
        private void appendLine(string text)
        {
            xml.Append(indent);
            xml.AppendLine(text);
        }

        public override string ToString()
        {
            return xml.ToString();
        }
    }
}

By viewing downloads associated with this article you agree to the Terms of Service and the article's licence.

If a file you wish to view isn't highlighted, and is a text file (not binary), please let us know and we'll add colourisation support for it.

License

This article, along with any associated source code and files, is licensed under The GNU General Public License (GPLv3)


Written By
pdfforge GbR
Germany Germany
Philip is a Software Architect with severaly years of experience. He studied business IT in the University of Wedel, Germany, and has reached his Masters degree in 2010. Back in 2002, he started his so far best-known software PDFCreator. The second developer joined two years later and since then, both constantly improve this piece of open source software.

Comments and Discussions