Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Custom Config Section Property is not a configuration element

Tags:

c#

app-config

I need another set of eyes on this problem. I am getting a

ConfigurationErrorsException was unhandled "Property 'exportClientSettings' is not a ConfigurationElement."

The exception is thrown when I call ExportClientConfiguration.GetSection();

Here is my code:

App.config

  <configSections>
<section name="exportClientConfiguration" type="ClientConversionUtilityBroker.ConfigurationModels.ExportClientPathConfiguration.ExportClientConfiguration, ClientConversionUtilityBroker"/>
</configSections>
<exportClientConfiguration>
  <exportClientSettings>
    <exportClientSetting name="Example" Path="\\Example\Path" />
  </exportClientSettings>
</exportClientConfiguration>

C# code

/// <summary>
/// The export client configuration section.
/// </summary>
public class ExportClientConfiguration : ConfigurationSection, IExportClientConfiguration
{
    private const string ExportClientSettingsCollectionName = "exportClientSettings";

    /// <summary>
    /// Gets the export client configuration items.
    /// </summary>
    /// <value>
    /// The export client configuration items.
    /// </value>
    [ConfigurationProperty(ExportClientSettingsCollectionName, IsDefaultCollection = true)]
    public IEnumerable<ExportClientSettings> ExportClientConfigurationItems
    {
        get { return base[ExportClientSettingsCollectionName] as ExportClientSettingsCollection; }
    }

    /// <summary>
    /// Gets the export client path settings.
    /// </summary>
    /// <value>
    /// The export client path settings.
    /// </value>
    public IList<IExportClientSettings> ExportClientSettings
    {
        get { return ExportClientConfigurationItems.ToList<IExportClientSettings>(); }
    }

    /// <summary>
    ///     Gets the section.
    /// </summary>
    /// <param name="configurationSectionName">Name of the configuration section.</param>
    /// <returns>The configuration section.</returns>
    public static IExportClientConfiguration GetSection(string configurationSectionName = "exportClientConfiguration")
    {
        IExportClientConfiguration section = ConfigurationManager.GetSection(configurationSectionName) as ExportClientConfiguration;

        return section;
    }
}

/// <summary>
/// An <c>IEnumerable</c> collection fo <c>ExportClientSettings</c>
/// </summary>
[ConfigurationCollection(typeof(ExportClientSettings), AddItemName = "exportClientSetting")]
public class ExportClientSettingsCollection : ConfigurationElementCollection, IEnumerable<ExportClientSettings>
{
    /// <summary>
    /// Gets the <see cref="ExportClientSettings"/> at the specified index.
    /// </summary>
    /// <value>
    /// The <see cref="ExportClientSettings"/>.
    /// </value>
    /// <param name="index">The index.</param>
    /// <returns></returns>
    public ExportClientSettings this[int index]
    {
        get { return BaseGet(index) as ExportClientSettings; }
    }

    /// <summary>
    /// Returns an enumerator that iterates through the collection.
    /// </summary>
    /// <returns>
    /// A <see cref="T:System.Collections.Generic.IEnumerator`1" /> that can be used to iterate through the collection.
    /// </returns>
    public new IEnumerator<ExportClientSettings> GetEnumerator()
    {
        return (from item in Enumerable.Range(0, Count)
                select this[item]).GetEnumerator();
    }

    protected override ConfigurationElement CreateNewElement()
    {
        return new ExportClientSettings();
    }

    protected override object GetElementKey(ConfigurationElement element)
    {
        var lConfigElement = element as ExportClientSettings;

        return lConfigElement != null ? lConfigElement.Name : null;
    }
}

/// <summary>
/// The export client path settings
/// </summary>
public class ExportClientSettings : ConfigurationElement, IExportClientSettings
{
    private const string NameProperty = "name";
    private const string PathProperty = "path";

    /// <summary>
    /// Gets the name.
    /// </summary>
    /// <value>
    /// The name to identify the export path and filename.
    /// </value>
    [ConfigurationProperty(NameProperty, IsKey = true)]
    public string Name
    {
        get { return this[NameProperty].ToString(); }
    }

    /// <summary>
    /// Gets the path.
    /// </summary>
    /// <value>
    /// The path.
    /// </value>
    [ConfigurationProperty(PathProperty)]
    public string Path
    {
        get { return this[PathProperty].ToString(); }
    }
}

What am I missing?

like image 897
tdbeckett Avatar asked Jan 09 '23 16:01

tdbeckett


1 Answers

Couple of problems.

  1. ExportClientConfigurationItems property should be of type ExportClientSettingsCollection not IEnumerable<ExportClientSettings>.
  2. In your config file Path is in capital letters, it should be in small letters path=\\Example\Path", as you've decorated the property with ConfigurationProperty in lower case.

Fixing these two, it works.

like image 200
Sriram Sakthivel Avatar answered Jan 21 '23 17:01

Sriram Sakthivel