Share via


ReadString Method

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

When overridden in a derived class, reads the contents of an element or text node as a string.

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

Syntax

'Declaration
Public Overridable Function ReadString As String
public virtual string ReadString()
public:
virtual String^ ReadString()
abstract ReadString : unit -> string 
override ReadString : unit -> string 
public function ReadString() : String

Return Value

Type: System. . :: . .String
The contents of the element or an empty string.

Remarks

This method returns the content of element, text, white space, significant white space or CDATA nodes.

If positioned on an element, ReadString concatenates all text, significant white space, white space, and CDATA section nodes together and returns the concatenated data as the element content. It stops when any markup is encountered, including comments and processing instructions. This could occur in a mixed content model, or when an element end tag is read.

If positioned on an element text node, ReadString performs the same concatenation from the text node to the element end tag. If the reader is positioned on an attribute text node, ReadString has the same functionality as if the reader were positioned on the element start tag. It returns all the concatenated element text nodes.

If positioned on an attribute, ReadString returns an empty string and moves the reader back to the element that owns the attribute.

If ReadString is called on any other node type, it returns an empty string and the reader is positioned on the next node.

.NET Framework Security

See Also

Reference

XmlReader Class

System.Xml Namespace