c# - net - Sección de app.config personalizada con una lista simple de elementos "agregar"

custom section name

Question

¿Cómo creo una sección de app.config personalizada que es solo una lista simple de add elementos?

He encontrado algunos ejemplos (por ejemplo, ¿Cómo crear una sección de configuración personalizada en app.config? ) Para secciones personalizadas que se ven así:

<RegisterCompanies>
<Companies>
<Company name="Tata Motors" code="Tata"/>
<Company name="Honda Motors" code="Honda"/>
</Companies>
</RegisterCompanies>

Pero, ¿cómo evito el elemento de recopilación adicional ("Compañías") para que se vea igual que las secciones appSettings y connectionStrings ? En otras palabras, me gustaría:

<registerCompanies>
<add name="Tata Motors" code="Tata"/>
<add name="Honda Motors" code="Honda"/>
</registerCompanies>

Answer 1

Ejemplo completo con código basado en el archivo de configuración OP:

<configuration>
<configSections>
<section name="registerCompanies"
type="My.MyConfigSection, My.Assembly" />
</configSections>
<registerCompanies>
<add name="Tata Motors" code="Tata"/>
<add name="Honda Motors" code="Honda"/>
</registerCompanies>
</configuration>

Aquí está el código de muestra para implementar una sección de configuración personalizada con la colección contraída

using System.Configuration;
namespace My {
public class MyConfigSection : ConfigurationSection {
[ConfigurationProperty("", IsRequired = true, IsDefaultCollection = true)]
public MyConfigInstanceCollection Instances {
get { return (MyConfigInstanceCollection)this[""]; }
set { this[""] = value; }
}
}
public class MyConfigInstanceCollection : ConfigurationElementCollection {
protected override ConfigurationElement CreateNewElement() {
return new MyConfigInstanceElement();
}
protected override object GetElementKey(ConfigurationElement element) {
//set to whatever Element Property you want to use for a key
return ((MyConfigInstanceElement)element).Name;
}
}
public class MyConfigInstanceElement : ConfigurationElement {
//Make sure to set IsKey=true for property exposed as the GetElementKey above
[ConfigurationProperty("name", IsKey = true, IsRequired = true)]
public string Name {
get { return (string) base["name"]; }
set { base["name"] = value; }
}
[ConfigurationProperty("code", IsRequired = true)]
public string Code {
get { return (string) base["code"]; }
set { base["code"] = value; }
} } }

Aquí hay un ejemplo de cómo acceder a la información de configuración desde el código.

var config = ConfigurationManager.GetSection("registerCompanies")
as MyConfigSection;
Console.WriteLine(config["Tata Motors"].Code);
foreach (var e in config.Instances) {
Console.WriteLine("Name: {0}, Code: {1}", e.Name, e.Code);
}

Answer 2

My.Assembly in config me dio Exception, porque llamé proyecto "Mi" no "Mi.Assembly". ¡Ten cuidado, si usas este ejemplo!

Answer 3

No es necesaria una sección de configuración personalizada.

App.Config

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<configSections>
<section name="YourAppSettings" type="System.Configuration.AppSettingsSection, System.Configuration, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a" />
</configSections>
<!-- value attribute is optional. omit if you just want a list of ''keys'' -->
<YourAppSettings>
<add key="one" value="1" />
<add key="two" value="2"/>
<add key="three" value="3"/>
<add key="duplicate" value="aa"/>
<add key="duplicate" value="bb"/>
</YourAppSettings>
</configuration>

Recuperar

// This casts to a NameValueCollection because the section is defined as a
/// AppSettingsSection in the configSections.
NameValueCollection settingCollection =
(NameValueCollection)ConfigurationManager.GetSection("YourAppSettings");
var items = settingCollection.Count;
Debug.Assert(items == 4); // no duplicates... the last one wins.
Debug.Assert(settingCollection["duplicate"] == "bb");
// Just keys as per original question? done... use em.
string[] allKeys = settingCollection.AllKeys;
// maybe you did want key/value pairs. This is flexible to accommodate both.
foreach (string key in allKeys)
{
Console.WriteLine(key + " : " + settingCollection[key]);
}

Answer 4

Según la respuesta anterior de Jay Walker , este es un ejemplo de trabajo completo que agrega la capacidad de indexar:

<configuration>
<configSections>
<section name="registerCompanies"
type="My.MyConfigSection, My.Assembly" />
</configSections>
<registerCompanies>
<add name="Tata Motors" code="Tata"/>
<add name="Honda Motors" code="Honda"/>
</registerCompanies>
</configuration>

Aquí está el código de muestra para implementar una sección de configuración personalizada con la colección contraída

using System.Configuration;
using System.Linq;
namespace My
{
public class MyConfigSection : ConfigurationSection
{
[ConfigurationProperty("", IsRequired = true, IsDefaultCollection = true)]
public MyConfigInstanceCollection Instances
{
get { return (MyConfigInstanceCollection)this[""]; }
set { this[""] = value; }
}
}
public class MyConfigInstanceCollection : ConfigurationElementCollection
{
protected override ConfigurationElement CreateNewElement()
{
return new MyConfigInstanceElement();
}
protected override object GetElementKey(ConfigurationElement element)
{
//set to whatever Element Property you want to use for a key
return ((MyConfigInstanceElement)element).Name;
}
public new MyConfigInstanceElement this[string elementName]
{
get
{
return this.OfType<MyConfigInstanceElement>().FirstOrDefault(item => item.Name == elementName);
}
}
}
public class MyConfigInstanceElement : ConfigurationElement
{
//Make sure to set IsKey=true for property exposed as the GetElementKey above
[ConfigurationProperty("name", IsKey = true, IsRequired = true)]
public string Name
{
get { return (string)base["name"]; }
set { base["name"] = value; }
}
[ConfigurationProperty("code", IsRequired = true)]
public string Code
{
get { return (string)base["code"]; }
set { base["code"] = value; }
}
}
}

Aquí hay un ejemplo de cómo acceder a la información de configuración desde el código.

MyConfigSection config =
ConfigurationManager.GetSection("registerCompanies") as MyConfigSection;
Console.WriteLine(config.Instances["Honda Motors"].Code);
foreach (MyConfigInstanceElement e in config.Instances)
{
Console.WriteLine("Name: {0}, Code: {1}", e.Name, e.Code);
}

Answer 5

Según la respuesta de Jay Walker, debe accederse a los elementos iterando a través de la colección "Instancias". es decir.

var config = ConfigurationManager.GetSection("registerCompanies")
as MyConfigSection;
foreach (MyConfigInstanceElement e in config.Instances) {
Console.WriteLine("Name: {0}, Code: {1}", e.Name, e.Code);
}