Export (0) Print
Expand All

XmlReader.ReadElementContentAsString Method ()

Note: This method is new in the .NET Framework version 2.0.

Reads the current element and returns the contents as a String object.

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

'Declaration
Public Overridable Function ReadElementContentAsString As String
'Usage
Dim instance As XmlReader
Dim returnValue As String

returnValue = instance.ReadElementContentAsString
public String ReadElementContentAsString ()
public function ReadElementContentAsString () : String

Return Value

The element content as a String object.

Exception typeCondition

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 a null reference (Nothing in Visual Basic) arguments.

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 Reading Typed Data and the W3C XML Schema Part 2: Datatypes recommendation (http://www.w3.org/TR/xmlschema-2/).

The following example reads the stringValue element and returns the text content (ignoring the comment and processing instruction).

Using reader As XmlReader = XmlReader.Create("dataFile.xml")
  reader.ReadToFollowing("stringValue")
  Console.WriteLine(reader.ReadElementContentAsString())
End Using

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>

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0

.NET Compact Framework

Supported in: 2.0

Community Additions

ADD
Show:
© 2014 Microsoft