XmlReader.ReadElementContentAsString Method (String, String)

Checks that the specified local name and namespace URI matches that of the current element, then reads the current element and returns the contents as a String object.

Namespace:  System.Xml
Assemblies:   System.Xml (in System.Xml.dll)
  System.Xml.ReaderWriter (in System.Xml.ReaderWriter.dll)

public virtual string ReadElementContentAsString(
	string localName,
	string namespaceURI
)

Parameters

localName
Type: System.String

The local name of the element.

namespaceURI
Type: System.String

The namespace URI of the element.

Return Value

Type: System.String
The element content as a String object.

ExceptionCondition
InvalidOperationException

The XmlReader is not positioned on an element.

XmlException

The current element contains child elements.

-or-

The element content cannot be converted to a String object.

ArgumentNullException

The method is called with null arguments.

ArgumentException

The specified local name and namespace URI do not match that of the current element being read.

InvalidOperationException

An XmlReader method was called before a previous asynchronous operation finished. In this case, InvalidOperationException is thrown with the message “An asynchronous operation is already in progress.”

This method reads the start tag, the contents of the element, and moves the reader past the end element tag. It expands entities and ignores processing instructions and comments. The element can only contain simple content. That is, it cannot have child elements.

For more information, see the Remarks section of the XmlReader reference page and the W3C XML Schema Part 2: Datatypes recommendation.

The following example reads the stringValue element and returns the text content (ignoring the comment and processing instruction).

using (XmlReader reader = XmlReader.Create("dataFile.xml")) {
     reader.ReadToFollowing("stringValue");
     Console.WriteLine(reader.ReadElementContentAsString("stringValue", ""));
}

The example uses the dataFile.xml file as input.

<root>
  <stringValue>
     <!--comment-->
     <?some pi?>
      text value of the element.
  </stringValue>
  <longValue>270000000000001</longValue>
  <number>0</number>
  <double>2E10</double>
  <date>2003-01-08T15:00:00-00:00</date>
</root>

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

Supported in: Windows Phone 8.1

Supported in: Windows Phone Silverlight 8.1

Supported in: Windows Phone Silverlight 8

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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
Show:
© 2014 Microsoft