Export (0) Print
Expand All

XmlReader.ReadElementContentAsObject Method

Reads the current element and returns the contents as an Object.

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

public virtual Object ReadElementContentAsObject()

Return Value

Type: System.Object
A boxed common language runtime (CLR) object of the most appropriate type. The ValueType property determines the appropriate CLR type. If the content is typed as a list type, this method returns an array of boxed objects of the appropriate type.

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.

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 Reading Typed Data and the W3C XML Schema Part 2: Datatypes recommendation.

The following example uses the method to read the content of the price node. The reader uses the information in the schema to map the content to the correct data type.


  // Create a validating reader.
  XmlReaderSettings settings = new XmlReaderSettings();
  settings.ValidationType = ValidationType.Schema;
  settings.Schemas.Add("urn:items", "item.xsd");	
   XmlReader reader = XmlReader.Create("item.xml", settings); 

  // Get the CLR type of the price element. 
  reader.ReadToFollowing("price");
  Console.WriteLine(reader.ValueType);

  // Return the value of the price element as Decimal object.
  Decimal price = (Decimal) reader.ReadElementContentAsObject();

  // Add 2.50 to the price.
  price = Decimal.Add(price, 2.50m);



The example uses the following two files as input.

item.xml


<item xmlns="urn:items" productID='123098'>
 <name>hammer</name>
 <price>9.95</price>
 <supplierID>1929</supplierID>
</item>


item.xsd


<?xml version="1.0"?>
<xs:schema xmlns:tns="urn:items" attributeFormDefault="unqualified" elementFormDefault="qualified" targetNamespace="urn:items" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="item">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="name" type="xs:string" />
        <xs:element name="price" type="xs:decimal" />
        <xs:element name="supplierID" type="xs:unsignedShort" />
      </xs:sequence>
      <xs:attribute name="productID" type="xs:unsignedInt" use="required" />
    </xs:complexType>
  </xs:element>
</xs:schema>


.NET Framework

Supported in: 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

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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

Community Additions

ADD
Show:
© 2014 Microsoft