This documentation is archived and is not being maintained.

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 Overridable Function ReadString As String
Dim instance As XmlReader 
Dim returnValue As String 

returnValue = instance.ReadString()

Return Value

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


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 reader As XmlReader = XmlReader.Create("book3.xml")               
  ' Parse the XML document.  ReadString is used to  
  ' read the text content of the elements.
  Console.Write("The content of the title element:  ")
  Console.Write("The content of the price element:  ")
End Using

The example uses the book3.xml file.

  <title>Pride And Prejudice</title>

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

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

.NET Compact Framework

Supported in: 3.5, 2.0, 1.0

XNA Framework

Supported in: 3.0, 2.0, 1.0