Click here to Skip to main content
65,938 articles
CodeProject is changing. Read more.
Articles / Languages / XML

Getting LineNumber(s) in your XLINQ

4.86/5 (9 votes)
26 Jun 2015CPOL 13.2K  
Getting LineNumber(s) in your XLINQ

At work, the other day, I had to do some work with some XML fragments, which I decided to do using XLinq.

Where I wanted to validate a certain fragment, and also get line numbers out of the fragment when it was deemed invalid. Say I had this XML:

XML
<?xmlversion="1.0" encoding="utf-8"?>
<Clients>
  <Client>
    <FirstName>Travis</FirstName>
    <LastName>Bickle</LastName>
  </Client>
  <Client>
    <FirstName>Franics</FirstName>
    <LastName>Bacon</LastName>
  </Client>
</Clients>

XLine actually supoprts line numbers by the way of the IXmlLineInfo Interface.

So say, you had some code like this which grabbed a XNode and wanted to use its line number:

C#
XText travis = (from x in xml.DescendantNodes().OfType<XText>()
                where x.Value == "Travis"
                select x).Single();

var lineInfo = (IXmlLineInfo)travis;
Console.WriteLine("{0} appears on line {1}", travis, lineInfo.LineNumber);

What I was finding though was that my line numbers were always coming out with 0 reported as the lineNumber. Turns out there is a easy win for this, it is to do with how I was initially loading the XDocument. I was doing this:

C#
var xml = XDocument.Load(file);

Which is bad, and will not load the line numbers. You need to do this instead:

C#
var xml = XDocument.Load(file, LoadOptions.SetLineInfo);

For a much better write up on all of this, check out this old post by Charlie Calvert, it's much better than my post, wish I had found that one first:

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)