XmlReader.ReadElementContentAs Method (Type, IXmlNamespaceResolver)

Reads the element content as the requested type.

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

public virtual Object ReadElementContentAs(
	Type returnType,
	IXmlNamespaceResolver namespaceResolver
)

Parameters

returnType
Type: System.Type

The type of the value to be returned.

Note   With the release of the .NET Framework 3.5, the value of the returnType parameter can now be the DateTimeOffset type.

namespaceResolver
Type: System.Xml.IXmlNamespaceResolver

An IXmlNamespaceResolver object that is used to resolve any namespace prefixes related to type conversion.

Return Value

Type: System.Object
The element content converted to the requested typed object.

ExceptionCondition
InvalidOperationException

The XmlReader is not positioned on an element.

XmlException

The current element contains child elements.

-or-

The element content cannot be converted to the requested type.

ArgumentNullException

The method is called with null arguments.

OverflowException

Read Decimal.MaxValue.

InvalidOperationException

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.”

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 ReadElementContentAsAsync.

The following example uses the ReadElementContentAs method to read the content of the date node.

  using (XmlReader reader = XmlReader.Create("dataFile.xml")) {
       reader.ReadToFollowing("date");
       DateTime date = (DateTime) reader.ReadElementContentAs(typeof(System.DateTime), null);
	
       // If the current culture is "en-US",
       // this writes "Wednesday, January 8, 2003".
       Console.WriteLine(date.ToLongDateString());	
  }

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>

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone Silverlight 8.1, Windows Phone Silverlight 8

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft