System.Xml.XmlReader.ReadElementString Method

Checks that the XmlReader.Name property of the element found matches the given string before reading a text-only element.

Syntax

public virtual string ReadElementString (string name)

Parameters

name
The name to check.

Returns

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

Exceptions

TypeReason
System.Xml.XmlExceptionThe node is not an Element node, the XmlReader.Name property of the Element node does not equal name, the element does not contain a simple text value, or an error occurred while parsing the XML.

Remarks

This is a helper method for reading simple text-only elements. It calls XmlReader.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.

Requirements

Namespace: System.Xml
Assembly: System.Xml (in System.Xml.dll)
Assembly Versions: 1.0.5000.0, 2.0.0.0, 4.0.0.0