Using Custom Configuration Section and Configuration Manager class in .NET – 2
Views (254)
Nishant Rana
11,325
Microsoft Employee
Like
Share
ReportSuppose we want to create a custom config section in this following manner
<queryTypes>
<queryType name=“qt1“ value=“qt1 value“></queryType>
<queryType name=“qt2“ value=“qt2 value“></queryType>
</queryTypes>
For implementing the above custom section we need to first define a class inheriting from ConfigurationSection class
Add reference to System.Configuration dll.
Create a new config section class in the following manner
// implement ConfiguraionSection class
class QueryTypesSection : ConfigurationSection
{
public QueryTypesSection()
{
}
[ConfigurationProperty(“”, IsDefaultCollection = true)]
public QueryTypesCollection QueryTypes
{
get
{
return (QueryTypesCollection)base[“”];
}
}
}
// Represents a configuration element containing a collection of child elements
public sealed class QueryTypesCollection : ConfigurationElementCollection
{
protected override ConfigurationElement CreateNewElement()
{
return new QueryTypeElement();
}
protected override object GetElementKey(ConfigurationElement element)
{
return ((QueryTypeElement)element).Name;
}
public override ConfigurationElementCollectionType CollectionType
{
get
{
return ConfigurationElementCollectionType.BasicMap;
}
}
protected override string ElementName
{
get
{
return “queryType”;
}
}
}
// Defining QueryTypeElement with name and value attribute
public sealed class QueryTypeElement : ConfigurationElement
{
// defining name attribute
[ConfigurationProperty(“name”, IsRequired = true)]
public string Name
{
get
{
return (string)this [“name”];
}
set
{
this[“name”] = value;
}
}
// defining value attribute
[ConfigurationProperty(“value”, IsRequired = true)]
public string Value
{
get
{
return (string)this[“value”];
}
set
{
this[“value”] = value;
}
}
}
Now to register your custom section do the following
<configSections>
<section name=“queryTypes“ type=“namespace.QueryTypesSection, namespace “ />
</configSections>
And to use it within the application
QueryTypesSection queryTypeSection = (QueryTypesSection)ConfigurationManager.GetSection(“queryTypes”);
QueryTypesCollection queryTypeCollection = queryTypeSection.QueryTypes;
foreach (QueryTypeElement se in queryTypeCollection)
{
string name=se.Name;
string value = se.Value;
}
That’s it…
Posted in .NET Framework Tagged: .NET Framework
This was originally posted here.
*This post is locked for comments