Export (0) Print
Expand All

XmlReader.ReadElementString Method ()

Reads a text-only element.

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

public virtual string ReadElementString ()
public String ReadElementString ()
public function ReadElementString () : String

Return Value

The text contained in the element that was read. An empty string if the element is empty (<item></item> or <item/>).

Exception typeCondition

XmlException

The next content node is not a start tag; or the element found does not contain a simple text value.

This is a helper method for reading simple text-only elements. It calls MoveToContent to find the next content node and then parses its value as a simple string.

Using the XML, <name>Arlene Huff</name>, ReadElementString consumes the element and returns the string Arlene Huff.

This method cannot handle any markup (child elements, comments, processing instructions, and so on) inside the name element, but it can concatenate multiple adjacent text and CDATA blocks.

After calling this method the reader will be positioned on the node following the EndElement node or after the empty element tag.

The following example uses ReadElementString to read the contents of the element nodes.

using System;
using System.Xml;

public class Sample
{
  private const String filename = "book.xml";

  public static void Main()
  {
    XmlTextReader reader = null;

    try
    {           
      // Load the file and ignore all white space.
      reader = new XmlTextReader(filename);
      reader.WhitespaceHandling = WhitespaceHandling.None;

      // Moves the reader to the root element.
      reader.MoveToContent();

      // Read the title and price elements.
      Console.WriteLine("Content of the title element: {0}", reader.ReadElementString());
      Console.WriteLine("Content of the price element: {0}", reader.ReadElementString());; 
         
    }
    finally
    {
      if (reader!=null)
        reader.Close();
    }
  }
} // End class

import System.*;
import System.Xml.*;

public class Sample
{
    private static String fileName = "book.xml";

    public static void main(String[] args)
    {
        XmlTextReader reader = null;
        try {
            // Load the file and ignore all white space.
            reader = new XmlTextReader(fileName);
            reader.set_WhitespaceHandling(WhitespaceHandling.None);

            // Moves the reader to the root element.
            reader.MoveToContent();

            // Read the title and price elements.
            Console.WriteLine("Content of the title element: {0}",
                reader.ReadElementString());
            Console.WriteLine("Content of the price element: {0}", 
                reader.ReadElementString());
        } 
        finally {
            if (reader != null) {
                reader.Close();
            }
        }
    } // main
} // End class Sample

The example uses the data file book.xml:


<!--sample XML fragment-->
<book genre='novel' ISBN='1-861003-78' misc='sale-item'>
  <title>The Handmaid's Tale</title>
  <price>14.95</price>
</book>

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

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

.NET Framework

Supported in: 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0

Community Additions

ADD
Show:
© 2014 Microsoft