ReadInnerXml Method
TOC
Collapse the table of content
Expand the table of content

XmlReader::ReadInnerXml Method ()

 

When overridden in a derived class, reads all the content, including markup, as a string.

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

public:
virtual String^ ReadInnerXml()

Return Value

Type: System::String^

All the XML content, including markup, in the current node. If the current node has no children, an empty string is returned.

If the current node is neither an element nor attribute, an empty string is returned.

Exception Condition
XmlException

The XML was not well-formed, or an error occurred while parsing the XML.

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 returns all the content of the current node including the markup. The current node (start tag) and corresponding end node (end tag) are not returned. For example, if you had the following:

<node>
 this <child id="123"/>
</node>

ReadInnerXml returns this <child id="123"/>

This method handles element and attribute nodes in the following manner:

Node type

Position before the call

XML fragment

Return value

Position after the call

Element

On the item1 start tag.

<item1>text1</item1><item2>text2</item2>

text1

On the item2 start tag.

Attribute

On the attr1 attribute node.

<item attr1="val1" attr2="val2">text</item>

val1

Remains on the attr1 attribute node.

If the reader is positioned on a leaf node, calling ReadInnerXml is equivalent to calling Read. The method returns String.Empty (except for attribute nodes, in which case the value of the attribute is returned).

This method checks for well-formed XML. If ReadInnerXml is called from an XmlValidatingReader, this method also validates the content returned.

As implemented in the XmlNodeReader, XmlTextReader and XmlValidatingReader classes the ReadOuterXml method is namespace aware.

For the asynchronous version of this method, see ReadInnerXmlAsync.

The following example compares the ReadInnerXml and ReadOuterXml methods.

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

The example uses 2books.xml file as input.

<!--sample XML fragment-->
<bookstore>
  <book genre='novel' ISBN='10-861003-324'>
    <title>The Handmaid's Tale</title>
    <price>19.95</price>
  </book>
  <book genre='novel' ISBN='1-861001-57-5'>
    <title>Pride And Prejudice</title>
    <price>24.95</price>
  </book>
</bookstore>

Universal Windows Platform
Available since 4.5
.NET Framework
Available since 1.1
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:
© 2016 Microsoft