XmlReader.ReadString Method

When overridden in a derived class, reads the contents of an element or text node as a string.

Namespace:  System.Xml
Assembly:  System.Xml (in System.Xml.dll)

public virtual string ReadString()

Return Value

Type: System.String
The contents of the element or an empty string.

ExceptionCondition
XmlException

An error occurred while parsing the XML.

This method returns the content of element, text, white space, significant white space or CDATA nodes.

If positioned on an element, ReadString concatenates all text, significant white space, white space, and CDATA section nodes together and returns the concatenated data as the element content. It stops when any markup is encountered, including comments and processing instructions. This could occur in a mixed content model, or when an element end tag is read.

If positioned on an element text node, ReadString performs the same concatenation from the text node to the element end tag. If the reader is positioned on an attribute text node, ReadString has the same functionality as if the reader were positioned on the element start tag. It returns all the concatenated element text nodes.

If positioned on an attribute, ReadString returns an empty string and moves the reader back to the element that owns the attribute.

If ReadString is called on any other node type, it returns an empty string and the reader is positioned on the next node.

The following example displays the text content of each element.


using (XmlReader reader = XmlReader.Create("book3.xml")) {

  // Parse the XML document.  ReadString is used to 
  // read the text content of the elements.
  reader.Read(); 
  reader.ReadStartElement("book");  
  reader.ReadStartElement("title");   
  Console.Write("The content of the title element:  ");
  Console.WriteLine(reader.ReadString());
  reader.ReadEndElement();
  reader.ReadStartElement("price");
  Console.Write("The content of the price element:  ");
  Console.WriteLine(reader.ReadString());
  reader.ReadEndElement();
  reader.ReadEndElement();

}


The example uses the book3.xml file.


<book>
  <title>Pride And Prejudice</title>
  <price>19.95</price>
</book>


.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft