Reading custom configuration section's key values in C#

Question

I need to read key values from custom sections in app/web.config.

I went through

Reading a key from the Web.Config using ConfigurationManager

and

How can I retrieve list of custom configuration sections in the .config file using C#?

However, they do not specify how to read a custom section when we need to explicitly specify the path to the configuration file (in my case, the configuration file is not in it's default location)

Example of my web.config file:

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
  <MyCustomTag> 
    <add key="key1" value="value1" />
    <add key="key2" value="value2" />
  </MyCustomTag>
<system.web>
  <compilation related data />
 </system.web> 
</configuration>

in which i need to read key value pairs inside MyCustomTag.

When i try (configFilePath is the path to my configuration file):-

var configFileMap = new ExeConfigurationFileMap { ExeConfigFilename = configFilePath };

var config =
          ConfigurationManager.OpenMappedExeConfiguration(
            configFileMap, ConfigurationUserLevel.None);

        ConfigurationSection section = config.GetSection(sectionName);

        return section[keyName].Value;

I get a error stating "Cannot access protected internal indexer 'this' here" at section[keyName]

There is nothing to do with the path of the custom settings in the web.config. you will be using `` — Saravanan, May 13 '13 at 14:38
`Cannot access protected internal indexer 'this'` -- it is a compiler error, right? Normally you will have to cast section to your type and use properties instead of that indexer. — Andrey Shchekin, May 14 '13 at 05:31
@AndreyShchekin Yes. Is there an example out there which demonstrates this method? — user720694, May 14 '13 at 05:42
@user85030 http://msdn.microsoft.com/en-us/library/2tw134k3.aspx for example (though it is not great). I do not remember what was the best thing I read about it. — Andrey Shchekin, May 14 '13 at 05:45

score 8 · Accepted Answer · answered May 14 '13 at 05:35

Unfortunately, this is not as easy as it sounds. The way to solve the problem is to get file config file with ConfigurationManager and then work with the raw xml. So, I normally use the following method:

private NameValueCollection GetNameValueCollectionSection(string section, string filePath)
{
        string file = filePath;
        System.Xml.XmlDocument xDoc = new System.Xml.XmlDocument();
        NameValueCollection nameValueColl = new NameValueCollection();

        System.Configuration.ExeConfigurationFileMap map = new ExeConfigurationFileMap();
        map.ExeConfigFilename = file;
        Configuration config = ConfigurationManager.OpenMappedExeConfiguration(map, ConfigurationUserLevel.None);
        string xml = config.GetSection(section).SectionInformation.GetRawXml();
        xDoc.LoadXml(xml);

        System.Xml.XmlNode xList = xDoc.ChildNodes[0];
        foreach (System.Xml.XmlNode xNodo in xList)
        {
            nameValueColl.Add(xNodo.Attributes[0].Value, xNodo.Attributes[1].Value);

        }

        return nameValueColl;
 }

And the call of the method:

 var bla = GetNameValueCollectionSection("MyCustomTag", @".\XMLFile1.xml");


for (int i = 0; i < bla.Count; i++)
{
    Console.WriteLine(bla[i] + " = " + bla.Keys[i]);
}

The result:

enter image description here

This answer does not mention why this approach is better than defining a custom section class (it *is* kind of more straightforward for simple case, but still). — Andrey Shchekin, May 14 '13 at 05:40
@Kai Thanks. I've accepted your answer. @".\XMLFile1.xml" is the path to the configuration file, right? — user720694, May 14 '13 at 05:45
@Kai It works! Also, i've replaced NameValueCollection with dictionaries for better performance. — user720694, May 14 '13 at 06:58

Jogai · Answer 2 · 2014-08-28T07:16:15.583

1

Formo makes it really easy, like:

dynamic config = new Configuration("customSection");
var appBuildDate = config.ApplicationBuildDate<DateTime>();

See Formo on Configuration Sections

edited Aug 28 '14 at 07:16

answered Aug 28 '14 at 07:04

Jogai

254
1
5
19

Reading custom configuration section's key values in C#

2 Answers2

Linked