XmlReader.ReadElementContentAsString Method

Definition

Namespace:

System.Xml

Assembly:

System.Xml.ReaderWriter.dll

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

Overloads

ReadElementContentAsString(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.
ReadElementContentAsString()	Reads the current element and returns the contents as a String object.

ReadElementContentAsString(String, String)

Source:

XmlReader.cs

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.

public:
 virtual System::String ^ ReadElementContentAsString(System::String ^ localName, System::String ^ namespaceURI);

public virtual string ReadElementContentAsString (string localName, string namespaceURI);

abstract member ReadElementContentAsString : string * string -> string
override this.ReadElementContentAsString : string * string -> string

Public Overridable Function ReadElementContentAsString (localName As String, namespaceURI As String) As String

Parameters

localName

String

The local name of the element.

namespaceURI

String

The namespace URI of the element.

Returns

String

The element content as a String object.

Exceptions

InvalidOperationException

The XmlReader is not positioned on an element.

-or-

An XmlReader method was called before a previous asynchronous operation finished. In this case, InvalidOperationException is thrown with the message "An asynchronous operation is already in progress."

XmlException

The current element contains child elements.

-or-

The element content cannot be converted to a String object.

ArgumentNullException

The method is called with null arguments.

ArgumentException

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

Examples

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", ""));
}

Using reader As XmlReader = XmlReader.Create("dataFile.xml")
  reader.ReadToFollowing("stringValue")
  Console.WriteLine(reader.ReadElementContentAsString("stringValue", ""))
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>

Remarks

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 the Remarks section of the XmlReader reference page and the W3C XML Schema Part 2: Datatypes recommendation.

ReadElementContentAsString()

Source:

XmlReader.cs

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

public:
 virtual System::String ^ ReadElementContentAsString();

public virtual string ReadElementContentAsString ();

abstract member ReadElementContentAsString : unit -> string
override this.ReadElementContentAsString : unit -> string

Public Overridable Function ReadElementContentAsString () As String

Returns

String

The element content as a String object.

Exceptions

InvalidOperationException

The XmlReader is not positioned on an element.

-or-

An XmlReader method was called before a previous asynchronous operation finished. In this case, InvalidOperationException is thrown with the message "An asynchronous operation is already in progress."

XmlException

The current element contains child elements.

-or-

The element content cannot be converted to a String object.

ArgumentNullException

The method is called with null arguments.

Examples

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());			
}

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>

Remarks

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 the Remarks section of the XmlReader reference page and the W3C XML Schema Part 2: Datatypes recommendation.

For the asynchronous version of this method, see ReadElementContentAsStringAsync.