XmlReader.ReadElementContentAs Method

Definition

Namespace:

System.Xml

Assembly:

System.Xml.ReaderWriter.dll

Reads the current element and returns the contents as an object of the type specified.

Overloads

ReadElementContentAs(Type, IXmlNamespaceResolver)	Reads the element content as the requested type.
ReadElementContentAs(Type, IXmlNamespaceResolver, String, String)	Checks that the specified local name and namespace URI matches that of the current element, then reads the element content as the requested type.

ReadElementContentAs(Type, IXmlNamespaceResolver)

Source:

XmlReader.cs

Reads the element content as the requested type.

public:
 virtual System::Object ^ ReadElementContentAs(Type ^ returnType, System::Xml::IXmlNamespaceResolver ^ namespaceResolver);

public virtual object ReadElementContentAs (Type returnType, System.Xml.IXmlNamespaceResolver namespaceResolver);

abstract member ReadElementContentAs : Type * System.Xml.IXmlNamespaceResolver -> obj
override this.ReadElementContentAs : Type * System.Xml.IXmlNamespaceResolver -> obj

Public Overridable Function ReadElementContentAs (returnType As Type, namespaceResolver As IXmlNamespaceResolver) As Object

Parameters

returnType

Type

The type of the value to be returned.

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

namespaceResolver

IXmlNamespaceResolver

An IXmlNamespaceResolver object that is used to resolve any namespace prefixes related to type conversion.

Returns

Object

The element content converted to the requested typed object.

Exceptions

InvalidOperationException

The XmlReader is not positioned on an element.

-or-

An XmlReader method was called before a previous asynchronous operation finished. In this case, InvalidOperationException is thrown with the message "An asynchronous operation is already in progress."

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.

OverflowException

Read Decimal.MaxValue.

Examples

The following example uses the ReadElementContentAs method to read the content of the date node.

using (XmlReader reader = XmlReader.Create("dataFile.xml")) {
     reader.ReadToFollowing("date");
     DateTime date = (DateTime) reader.ReadElementContentAs(typeof(System.DateTime), null);
  
     // If the current culture is "en-US",
     // this writes "Wednesday, January 8, 2003".
     Console.WriteLine(date.ToLongDateString());	
}

Using reader As XmlReader = XmlReader.Create("dataFile.xml")
  reader.ReadToFollowing("date")
  Dim [date] As DateTime = CType(reader.ReadElementContentAs(GetType(System.DateTime), Nothing), DateTime)
            
  ' If the current culture is "en-US",
  ' this writes "Wednesday, January 8, 2003".
  Console.WriteLine([date].ToLongDateString())
End Using

The example uses the dataFile.xml file as input.

<root>
  <stringValue>
     <!--comment-->
     <?some pi?>
      text value of the element.
  </stringValue>
  <longValue>270000000000001</longValue>
  <number>0</number>
  <double>2E10</double>
  <date>2003-01-08T15:00:00-00:00</date>
</root>

Remarks

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 the Remarks section of the XmlReader reference page and the W3C XML Schema Part 2: Datatypes recommendation.

For the asynchronous version of this method, see ReadElementContentAsAsync.

ReadElementContentAs(Type, IXmlNamespaceResolver, String, String)

Source:

XmlReader.cs

Checks that the specified local name and namespace URI matches that of the current element, then reads the element content as the requested type.

public:
 virtual System::Object ^ ReadElementContentAs(Type ^ returnType, System::Xml::IXmlNamespaceResolver ^ namespaceResolver, System::String ^ localName, System::String ^ namespaceURI);

public virtual object ReadElementContentAs (Type returnType, System.Xml.IXmlNamespaceResolver namespaceResolver, string localName, string namespaceURI);

abstract member ReadElementContentAs : Type * System.Xml.IXmlNamespaceResolver * string * string -> obj
override this.ReadElementContentAs : Type * System.Xml.IXmlNamespaceResolver * string * string -> obj

Public Overridable Function ReadElementContentAs (returnType As Type, namespaceResolver As IXmlNamespaceResolver, localName As String, namespaceURI As String) As Object

Parameters

returnType

Type

The type of the value to be returned.

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

namespaceResolver

IXmlNamespaceResolver

An IXmlNamespaceResolver object that is used to resolve any namespace prefixes related to type conversion.

localName

String

The local name of the element.

namespaceURI

String

The namespace URI of the element.

Returns

Object

The element content converted to the requested typed object.

Exceptions

InvalidOperationException

The XmlReader is not positioned on an element.

-or-

An XmlReader method was called before a previous asynchronous operation finished. In this case, InvalidOperationException is thrown with the message "An asynchronous operation is already in progress."

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.

ArgumentException

The specified local name and namespace URI do not match that of the current element being read.

OverflowException

Read Decimal.MaxValue.

Remarks

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 the Remarks section of the XmlReader reference page and the W3C XML Schema Part 2: Datatypes recommendation.