SparkyTools.XmlConfig.Fx 1.1.1

dotnet add package SparkyTools.XmlConfig.Fx --version 1.1.1
NuGet\Install-Package SparkyTools.XmlConfig.Fx -Version 1.1.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="SparkyTools.XmlConfig.Fx" Version="1.1.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add SparkyTools.XmlConfig.Fx --version 1.1.1
#r "nuget: SparkyTools.XmlConfig.Fx, 1.1.1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install SparkyTools.XmlConfig.Fx as a Cake Addin
#addin nuget:?package=SparkyTools.XmlConfig.Fx&version=1.1.1

// Install SparkyTools.XmlConfig.Fx as a Cake Tool
#tool nuget:?package=SparkyTools.XmlConfig.Fx&version=1.1.1

see also:


ConfigurationSectionDeserializer / ConfigurationSectionListDeserializer

These classes makes it easy to load a strongly-typed object (or IList of objects) from a custom web.config or app.config file section without having to write a custom IConfigurationSectionHandler implementation.

In the .config file, register each custom section with a type of "SparkyTools.XmlConfig.ConfigurationSectionDeserializer" or "SparkyTools.XmlConfig.ConfigurationSectionListDeserializer":

<configuration>
  <configSections>
    <section name="Foo" type="SparkyTools.XmlConfig.Fx.ConfigurationSectionDeserializer, SparkyTools.XmlConfig.Fx" />
    <section name="FooList" type="SparkyTools.XmlConfig.Fx.ConfigurationSectionListDeserializer, SparkyTools.XmlConfig.Fx" />
  </configSections>

In each registered custom section, specify the object type via the type attribute. Here's an single instance section:

  <Foo type="FooNamespace.Foo, FooAssemblyName">
    <Bar>bar</Bar>
    <Baz>123.45</Baz>
  </Foo>

...and a "list" section: (the type is the instance type, not "IList..."):

  <FooList type="FooNamespace.Bar, FooAssemblyName">
      <Foo>
        <Bar>bar1</Bar>
        <Baz>111.11</Baz>
      </Foo>
      <Foo>
        <Bar>bar2</Bar>
        <Baz>222.22</Baz>
      </Foo>
  </FooList>

To read from your custom .config section, just call the Load method, specifying the object type and the .config section name:

    Foo foo = ConfigurationSectionDeserializer.Load<Foo>("Foo");
    IList<Foo> fooList = ConfigurationSectionListDeserializer.Load<Foo>("FooList");

DependencyProvider methods

These methods create DependencyProviders for use with apps that use app.config / web.config files:

  • ConfigurationSectionDeserializer.DependencyProvider / ConfigurationSectionListDeserializer.DependencyProvider create DependencyProviders that load data from a .config file section:
    using SparkyTools.DependencyProvider;
    
    public class Foo
    {
        public Foo(
            DependencyProvider<Bar> barProvider, 
            DependencyProvider<IList<Baz>> bazProvider)
        {
        }
    }
    
    using SparkyTools.XmlConfig.Fx;
    . . .
        var foo = new Foo(
            ConfigurationSectionDeserializer.DependencyProvider<Bar>("Bar"),
            ConfigurationSectionListDeserializer.DependencyProvider<Baz>("BazList"));
    
  • AppSettings.DependencyProvider creates a DependencyProvider that wraps ConfigurationManager.AppSettings:
    using SparkyTools.DependencyProvider;
    
    public class Qux
    {
        private readonly Func<string, string> _getAppSetting;
    
        public Qux(DependencyProvider<Func<string, string> appSettingsProvider)
        {
            _getAppSetting = appSettingsProvider.GetValue();
        }
    
        public void MethodUsingAppSettings()
        {
            string valueFromAppSettings = _getAppSetting("key);
        }
    }
    
    using SparkyTools.XmlConfig.Fx;
    ...
        var qux = new Qux(AppSettings.DependencyProvider());
    
Product Compatible and additional computed target framework versions.
.NET Framework net45 is compatible.  net451 was computed.  net452 was computed.  net46 was computed.  net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.1.1 454 5/13/2021
1.1.0 293 5/13/2021
1.0.0 964 5/28/2018

New package created because SparkyTools.XmlConfig only supports .NET Framework 4.6 and above