System.Xml.XmlReader.ReadContentAsObject Method

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

Syntax

public virtual object ReadContentAsObject ()

Returns

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

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 XmlReader.ValueType property. If the content is a list type, the reader returns an array of boxed objects of the appropriate type.

Note:

If a validation error occurs while parsing the content and the reader is an System.Xml.XmlReader object created by the erload:System.Xml.XmlReader.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.

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 (XmlReaderSettings.ValidationType is set to ValidationType.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 tp://go.microsoft.com/fwlink/?LinkId=4871 recommendation.

For the asynchronous version of this method, see XmlReader.ReadContentAsObjectAsync.

Requirements

Namespace: System.Xml
Assembly: System.Xml (in System.Xml.dll)
Assembly Versions: 2.0.0.0, 4.0.0.0
Since: .NET 2.0