This topic has not yet been rated - Rate this topic

XmlReader.ReadElementContentAsString Method (String, String)

.NET Framework 4.5

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
Assembly: System.Xml (in System.Xml.dll)

Syntax

C++

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.

Exceptions

Exception	Condition
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.”

Remarks

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 Reading Typed Data and the W3C XML Schema Part 2: Datatypes recommendation.

For the asynchronous version of this method, see ReadElementContentAsStringAsync.

Examples

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.

None

<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>

Version Information

.NET Framework

Supported in: 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

Platforms

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.

Reference

XmlReader Class

ReadElementContentAsString Overload

System.Xml Namespace

Other Resources

Reading XML with the XmlReader

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)