XmlReader.ReadElementContentAsString Method (String, String)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

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)

abstract ReadElementContentAsString : 
        localName:string *
        namespaceURI:string -> string
override ReadElementContentAsString : 
        localName:string *
        namespaceURI:string -> string

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.

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

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

No code example is currently available or this language may not be supported.

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>

Universal Windows Platform
Available since 8
.NET Framework
Available since 2.0
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1
Return to top
Show: