How to define a basic custom configuration section?

Question

I have my own custom configuration sections but would like to create a new element that has simple key/values inside it. Now I have a working version but it seems quite a lot of code for such a simpler task. Is there an improved way of doing things?

Below is a stripped out version of my config and custom configuration class.

web.config

<myRootNode>
    <myNode>
        <add key="a" value="" />
        <add key="b" value="" />
        <add key="c" value="" />
        ...
    </myNode>
    ...any other nodes
</myRootNode>

Custom Configuration Class

public class MyRootNode : ConfigurationSection
{
    [ConfigurationProperty("myNode")]
    public MyNodeElement MyNode
    {
        get { return (MyNodeElement)this["myNode"]; }
    }
}

[ConfigurationCollection(typeof(BaseElement), AddItemName = "add")]
public class MyNodeElement : ConfigurationElementCollection
{
    protected override ConfigurationElement CreateNewElement()
    {
        return new BaseElement();
    }

    protected override object GetElementKey(ConfigurationElement element)
    {
        return ((BaseElement)element).Key;
    }

    public BaseElement this[int index]
    {
        get { return this.BaseGet(index) as BaseElement; }
    }
}

public class BaseElement : ConfigurationElement
{
    [ConfigurationProperty("key", IsRequired = true, IsKey = true)]
    public string Key
    {
        get { return this["key"].ToString(); }
    }

    [ConfigurationProperty("value", IsRequired = true)]
    public string Value
    {
        get { return this["value"].ToString(); }
    }
}

Try this article: Writing Custom Configuration Settings Section in C# — user1761784
– user1761784, Commented Oct 20, 2012 at 16:10

abatishchev · Accepted Answer · 2013-03-10 08:14:14Z

10

Something like this I guess:

  <configSections>
      <section name="validationXsds"  type="System.Configuration.DictionarySectionHandler, System" />
  </configSections>


  <validationXsds>
    <add key="http://schemas.xmlsoap.org/soap/envelope/" value="http://dev.ei.directv.com/schemas/xmlsoap/envelope.xsd"/>
    <add key="http://schemas.xmlsoap.org/soap/encoding/" value="http://dev.ei.directv.com/schemas/xmlsoap/encoding.xsd"/>
    <add key="http://ei.directv.com/schemas/envelope/v3_0" value="http://dev.ei.directv.com/schemas/envelope/v3.0/Envelope.xsd"/>
  </validationXsds>

IDictionary xsds = (IDictionary)WebConfigurationManager.GetSection("validationXsds");

Update: in .NET 4.0 I'm using

 type="System.Configuration.NameValueSectionHandler, System, Version=4.0.0.0,Culture=neutral, PublicKeyToken=b77a5c561934e089"

edited Mar 10, 2013 at 8:14

abatishchev

101k88 gold badges304 silver badges443 bronze badges

answered Jun 15, 2009 at 18:13

Andriy Volkov

19k9 gold badges71 silver badges85 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

John Rasch · Accepted Answer · 2009-06-15 18:19:40Z

6

Doing this manually requires way too much effort. You can have Visual Studio create the section for you with the Configuration Section Designer add-in.

answered Jun 15, 2009 at 18:19

John Rasch

63.6k19 gold badges110 silver badges141 bronze badges

2 Comments

David Over a year ago

Requires Visual Stuiod 2008 or greater.

TheHolyTerrah Over a year ago

Actually, VS 2010 isn't supported yet. :o(

Collectives™ on Stack Overflow

How to define a basic custom configuration section?

2 Answers 2

Comments

2 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

2 Comments

Your Answer

Sign up or log in

Post as a guest

Related