NXmlConfigHelper 1.1.1

NXmlConfigHelper

Small, dependency-free XML configuration library for .NET Framework 4.7.2 and .NET Standard 2.0.

It supports complete object/list serialization as well as safe updates of individual keys in different XML trees. Key updates preserve unrelated settings and write through a temporary file.

Object serialization

var serializer = new NXmlConfig<MySettings>();
serializer.Serialize(path, settings);
MySettings loaded = serializer.Deserialize(path);

var listSerializer = new NXmlConfig<MyItem>();
listSerializer.SerializeList(path, items);
List<MyItem> loadedItems = listSerializer.DeserializeList(path);

Static shortcuts are also available: NXmlConfig.Serialize(path, settings) and NXmlConfig.Deserialize<MySettings>(path).

DeSerialize and DeSerializeList aliases are included for compatibility with the original NXmlConfig API.

Work with one list item

var serializer = new NXmlConfig<MyItem>();

int newIndex = serializer.AddItem(path, new MyItem());
MyItem item = serializer.ReadItem(path, newIndex);

serializer.WriteItem(path, newIndex, changedItem);
MyItem removed = serializer.RemoveItem(path, newIndex);

ReadItem, WriteItem, and RemoveItem use a zero-based index. Updating one item rewrites the list atomically, so the XML file is never left partially written.

Read and write individual keys

var config = new XmlConfigFile(path);

config.WriteValue("mainUI", "machineName", "99");
config.WriteValue("motion", "timeoutMs", 3000);

string machineName = config.ReadValue("mainUI", "machineName", "Unknown");
int timeout = config.ReadValue("motion", "timeoutMs", 1000);

To use a variable's name as the XML key automatically:

string machineName = "99";
config.WriteVariable("mainUI", () => machineName);

machineName = config.ReadVariable("mainUI", () => machineName);

The resulting element is <machineName>99</machineName>. Fields and properties are supported as well as local variables.

Nested trees use / or \ separators:

config.WriteValue("motion/axisX", "homeSpeed", 125.5);

Dictionary serialization

Serialize a complete generic dictionary to its own XML file:

var values = new Dictionary<string, int>
{
    ["AxisX"] = 3000,
    ["AxisY"] = 5000
};

NXmlConfig.SerializeDictionary(path, values);
Dictionary<string, int> loaded =
    NXmlConfig.DeserializeDictionary<string, int>(path);

Or map a string-keyed dictionary into one configuration tree:

config.WriteDictionary("motion/timeouts", values);
Dictionary<string, int> loaded =
    config.ReadDictionary<int>("motion/timeouts");

Writing a tree dictionary updates the supplied keys and preserves other keys already in that tree.

Write multiple trees in one file operation

config.WriteEntries(new[]
{
    new XmlConfigEntry("mainUI", "machineName", "99"),
    new XmlConfigEntry("mainUI", "modelName", "M3T"),
    new XmlConfigEntry("motion/axisX", "timeoutMs", "3000")
});

This produces:

<configuration>
  <mainUI>
    <machineName>99</machineName>
    <modelName>M3T</modelName>
  </mainUI>
  <motion>
    <axisX>
      <timeoutMs>3000</timeoutMs>
    </axisX>
  </motion>
</configuration>

Additional operations include ContainsValue, ReadTree, RemoveValue, RemoveTree, WriteValues, and ReplaceAll.

Licensed under the MIT License.