C# XMLDocument Encoding?

Question

I'm trying to code a function that validates an XML settings file, so if a node does not exist on the file, it should create it.

I have this function

private void addMissingSettings() {
    XmlDocument xmldocSettings = new XmlDocument();
    xmldocSettings.Load("settings.xml");

    XmlNode xmlMainNode = xmldocSettings.SelectSingleNode("settings");

    XmlNode xmlChildNode = xmldocSettings.CreateElement("ExampleNode");
    xmlChildNode.InnerText = "Hello World!";

    //add to parent node
    xmlMainNode.AppendChild(xmlChildNode);
    xmldocSettings.Save("settings.xml");
}

But on my XML file, if I have

<rPortSuffix desc="Read Suffix">&#13;&#10;</rPortSuffix>
<wPortSuffix desc="Write Suffix">&#03;</wPortSuffix>

When the I save the document, it saves those lines as

<rPortSuffix desc="Read Suffix">
</rPortSuffix>
<wPortSuffix desc="Sufijo en puerto de escritura">&#x3;</wPortSuffix>
<ExampleNode>Hello World!</ExampleNode>

Is there a way to prevent this behaviour? Like setting a working charset or something like that?

Jon Skeet · Accepted Answer · 2012-08-22 21:08:18Z

1

The two files are equivalent, and should be treated as being equivalent by all XML parsers, I believe.

Additionally, Unicode character U+0003 isn't a valid XML character, so you've fundamentally got other problems if you're trying to represent it in your file. Even though that particular .NET XML parser doesn't seem to object, other parsers may well do so.

If you need to represent absolutely arbitrary characters in your XML, I suggest you do so in some other form - e.g.

<rPortSuffix desc="Read Suffix">\u000c\u000a</rPortSuffix>
<wPortSuffix desc="Write Suffix">\u0003</wPortSuffix>

Obviously you'll then need to parse that text appropriately, but at least the XML parser won't get in the way, and you'll be able to represent any UTF-16 code unit.

answered Aug 22, 2012 at 21:08

Jon Skeet

1.5m893 gold badges9.3k silver badges9.3k bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

desto Over a year ago

This works, no parsing required! So the correct way to represent Unicode characters is by that way?

C. M. Sperberg-McQueen Over a year ago

Two slightly pedantic corrections: The two files shown do differ slightly: before any other parsing is done a literal x0D x0A sequence will be normalized to a single x0A, while the numeric character references will not be normalized in the same way. Also, a numeric character reference to character 3 is legal in XML 1.1, though not in XML 1.0.

Collectives™ on Stack Overflow

C# XMLDocument Encoding?

1 Answer 1

2 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

2 Comments

Your Answer

Sign up or log in

Post as a guest

Related