Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
ReadElementContentAsString Method (String, String)
Collapse the table of content
Expand the table of content

XmlReader.ReadElementContentAsString Method (String, String)

Checks that the specified local name and namespace URI matches that of the current element, then reads the current element and returns the contents as a String object.

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

public virtual string ReadElementContentAsString (
	string localName,
	string namespaceURI
)
public String ReadElementContentAsString (
	String localName, 
	String namespaceURI
)
public function ReadElementContentAsString (
	localName : String, 
	namespaceURI : String
) : String
Not applicable.

Parameters

localName

The local name of the element.

namespaceURI

The namespace URI of the element.

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.

ArgumentException

The specified local name and namespace URI do not match that of the current element being read.

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.

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

using (XmlReader reader = XmlReader.Create("dataFile.xml")) {
     reader.ReadToFollowing("stringValue");
     Console.WriteLine(reader.ReadElementContentAsString("stringValue", ""));
}

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 Server 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 Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0

.NET Compact Framework

Supported in: 2.0

XNA Framework

Supported in: 1.0

Community Additions

ADD
Show:
© 2015 Microsoft