XmlReader.ReadElementContentAsDateTime Method

Reads the current element and returns the contents as a DateTime object.

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

public virtual DateTime ReadElementContentAsDateTime()

Return Value

Type: System.DateTime
The element content as a DateTime object.

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 a DateTime object.

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.

If the content is typed xsd:dateTime, the reader returns an unboxed DateTime object. If the content is not typed xsd:dateTime, the reader attempts to convert it to a DateTime object according to the rules defined by the W3C XML Schema Part 2: Datatypes recommendation.

NoteNote

You cannot rely on the DateTime.Year value when the content is typed as xsd:gMonthDay. XmlReader always sets the DateTime.Year value to 1904 in this case.

For more information, see Reading Typed Data.

The following example uses the ReadElementContentAsDateTime method to read the content of the date element.


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


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>


.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

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

Community Additions

ADD
Show:
© 2014 Microsoft