Click here to Skip to main content
65,938 articles
CodeProject is changing. Read more.
Articles
(untagged)

Creating Custom Configuration Sections in .NET

0.00/5 (No votes)
25 Jun 2008 1  
Every element in the configuration file maps to a class in the .NET framework.  It's possible to expand upon this to create custom configuration

This articles was originally at wiki.asp.net but has now been given a new home on CodeProject. Editing rights for this article has been set at Bronze or above, so please go in and edit and update this article to keep it fresh and relevant.

Every element in the configuration file maps to a class in the .NET framework.  It's possible to expand upon this to create custom configuration sections.  To do this, create a class that inherits from ConfigurationSection, like so:

public class MySection : ConfigurationSection { }

To expose attributes for our new element that can be defined in the configuration file, below is one of the possible syntaxes:

[ConfigurationProperty("defaultValue", IsRequired=true)]
public string DefaultValue
{
    get { return (string)this["defaultValue"]; }
    set { this["defaultValue"] = value; }
}

Let's look at this definition.  First, the ConfigurationProperty attribute exposes this property as an attribute.  There are other optional properties on the attribute that can be setup, such as IsRequired, DefaultValue, IsDefaultCollection, etc.  All of these properties determine how the configuration file will validate the XML.

Next, the property gets and sets value to a local dictionary.  This dictionary is object-based, and will create an entry for your attribute with a default value.  The key has to match the name of the configuration property defined in the attribute.  To make use of this, you must define the following in <configSections> element in the configuration file:

<section name="mySection" type="FullPath.To.MySection,Assembly" />

I can now define the following:

<mySection defaultValue="1" />

And access it using:

MySection section = (MySection)ConfigurationManager.GetSection("mySection");

This call to GetSection returns the instance of the section defined in the configuration file.

License

This article has no explicit license attached to it but may contain usage terms in the article text or the download files themselves. If in doubt please contact the author via the discussion board below.

A list of licenses authors might use can be found here