ReadElementString Method (String)

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

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

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

'Declaration
Public Overridable Function ReadElementString ( _
	name As String _
) As String

Parameters

name
Type: System..::..String
The name to check.

Return Value

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

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

Show: