XmlReader.ReadContentAs Method

Reads the content as an object of the type specified.

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

Public Overridable Function ReadContentAs ( _
	returnType As Type, _
	namespaceResolver As IXmlNamespaceResolver _
) As Object
Dim instance As XmlReader
Dim returnType As Type
Dim namespaceResolver As IXmlNamespaceResolver
Dim returnValue As Object

returnValue = instance.ReadContentAs(returnType, namespaceResolver)
public Object ReadContentAs (
	Type returnType, 
	IXmlNamespaceResolver namespaceResolver
public function ReadContentAs (
	returnType : Type, 
	namespaceResolver : IXmlNamespaceResolver
) : Object
Not applicable.



The type of the value to be returned.


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


An IXmlNamespaceResolver object that is used to resolve any namespace prefixes related to type conversion. For example, this can be used when converting an XmlQualifiedName object to an xs:string.

This value can be a null reference (Nothing in Visual Basic).

Return Value

The concatenated text content or attribute value converted to the requested type.

Exception typeCondition


The content is not in the correct format for the target type.


The attempted cast is not valid.


The returnType value is a null reference (Nothing in Visual Basic).


The current node is not a supported node type. See the table below for details.

This method reads the text content at the current reader position and converts it to the requested return type. Text, white space, significant white space and CDATA sections are concatenated. Comments and processing instructions are skipped and entity references are automatically resolved.

This method is used to read, convert if necessary, and return atomic value items from the current node content. If the input type is a valid mappings for the type of the current node then an instance of the target type containing the value of the current node is returned. The Default Mapping of XQuery 1.0 and XPath 2.0 to CLR Types topic has a list of the default mappings.

For example, if you had the following XML text:

<elem>123 <!-- comment --> <?pi my_text?> 456 <?pi another_pi?></elem>

If the data is typed and a string array is supplied to the ReadContentAs method call, then the integer values are converted from strings according to the list of valid CLR type mappings.

If the data is untyped and a string array is supplied to the ReadContentAs method call, then the content is parsed into separate strings. An array containing two strings is returned with the values "123" and "456". The spaces are not preserved from the content.

In general when reading untyped data the content is parsed according to the supplied type. For example, if an integer array is supplied to the ReadContentAs method call then the string is parsed into an array of integers {123,456}.

In the following example the XML text is not separated by spaces

<elem>123<!-- comment --><?pi my_text?>456789<?pi another_pi?></elem>

If the content is untyped and a string array is supplied to the ReadContentAs method call then an array containing one concatenated string is returned with the value "123456789".

The following table describes how this method treats each node type.


Return value

Reader behavior







Concatenated content of text, CDATA, white space and significant white space nodes converted to the requested type.

Moves to the next start element or end element tag. Entity references are automatically expanded.


Same as calling XmlConvert.ToXxx on the attribute value.

The reader remains in the current position.



Ignores the processing instruction (PI) or comment and reads the concatenated text content that follows the PI or comment.

Moves to the next start element or end element tag. Entity references are automatically expanded.


An empty string.

The reader remains in the current position.









An InvalidOperationException is thrown.

Undefined, although typically the reader remains in the current position.

For more information, see Reading Typed Data and the W3C XML Schema Part 2: Datatypes recommendation.

The following example uses the ReadContentAs method to return the contents of the colors element into an array of string objects.

Using reader As XmlReader = XmlReader.Create("dataFile_2.xml")

  Dim colors As String() = CType(reader.ReadContentAs(GetType(String()), Nothing), String())
  Dim color As String
  For Each color In  colors
    Console.WriteLine("Colors: {0}", color)
  Next color
End Using

The example uses the dataFile_2.xml file as input.

  <item sale-item='true' productID='123456' colors='blue green black'>
  <item sale-item='false' productID='124390'>
  <item sale-item='true' productID='53298'>

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