XmlReader.ReadContentAsObject Method

Microsoft Silverlight will reach end of support after October 2021. Learn more.

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

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

Syntax

'Declaration
Public Overridable Function ReadContentAsObject As Object
public virtual Object ReadContentAsObject()

Return Value

Type: System.Object
The text content as the most appropriate common language runtime (CLR) object.

Exceptions

Exception Condition
InvalidCastException

The attempted cast is not valid.

FormatException

The string format is not valid.

Remarks

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.

Element

XmlDeclaration

None

Document

DocumentType

Notation

Entity

DocumentFragment

An InvalidOperationException is thrown.

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

Version Information

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

XNA Framework

Supported in: Xbox 360, Windows Phone OS 7.0

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.