Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

XmlReader.ReadContentAsObject Method

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

Reads the text content at the current position as an Object.

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

public virtual Object ReadContentAsObject ()
public Object ReadContentAsObject ()
public function ReadContentAsObject () : Object

Return Value

The text content as the most appropriate common language runtime (CLR) object.

Exception typeCondition

InvalidCastException

The attempted cast is not valid.

FormatException

The string format is not valid.

This method concatenates text, white space, significant white space, and CDATA sections, and skips any comments or processing instructions. Entity references are automatically resolved.

If the content is typed, the reader returns a boxed CLR of the most appropriate type, specified by the ValueType property. If the content is a list type, the reader returns an array of boxed objects of the appropriate type.

NoteNote

If a validation error occurs while parsing the content and the reader is an XmlReader object created by the Create method, the reader returns the content as a string. In other words when a validation error or warning occurs, the content is considered to be untyped.

If the content is not typed, the reader returns the content as a string.

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

XmlNodeType

Return value

Reader behavior

Text

CDATA

Whitespace

SignificantWhitespace

EntityReference

EndEntity

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.

Attribute

Same as calling XmlConvert.ToXxx on the attribute value.

The reader remains in the current position

Comment

ProcessingInstruction

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.

EndElement

The value of the element if the reader is a schema validating reader (ValidationType is set to Schema); otherwise an empty string.

The reader remains in the current position.

Element

XmlDeclaration

None

Document

DocumentType

Notation

Entity

DocumentFragment

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 (http://www.w3.org/TR/xmlschema-2/).

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
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

Show:
© 2014 Microsoft