XmlConvert.ToDateTimeOffset Method (String)
Microsoft Silverlight will reach end of support after October 2021. Learn more.
Converts the supplied String to a DateTimeOffset equivalent.
Namespace: System.Xml
Assembly: System.Xml (in System.Xml.dll)
Syntax
'Declaration
Public Shared Function ToDateTimeOffset ( _
s As String _
) As DateTimeOffset
public static DateTimeOffset ToDateTimeOffset(
string s
)
Parameters
- s
Type: System.String
The string to convert.
Note The string must conform to a subset of the W3C Recommendation for the XML dateTime type. For more information see XML Schema Part 2: Datatypes.
Return Value
Type: System.DateTimeOffset
The DateTimeOffset equivalent of the supplied string.
Exceptions
| Exception | Condition |
|---|---|
| ArgumentNullException | s is nulla null reference (Nothing in Visual Basic). |
| ArgumentOutOfRangeException | The argument passed to this method is outside the range of allowable values. For information about allowable values, see DateTimeOffset. |
| FormatException | The argument passed to this method does not conform to a subset of the W3C Recommendations for the XML dateTime type. For more information see XML Schema Part 2: Datatypes. |
Remarks
When more than seven digits are specified for fractional seconds, the value is rounded. For example, 00000004 becomes 0000000 and 00000005 becomes 0000001.
Examples
Dim xmlString As String = _
"<?xml version='1.0'?>" & _
"<transactions>" & _
"<transaction>" & _
"<id>123456789</id>" & _
"<amount>1.00</amount>" & _
"<currency>USD</currency>" & _
"<time>2007-08-03T22:05:13-07:00</time>" & _
"</transaction>" & _
"</transactions>"
' Create an XmlReader
Using reader As XmlReader = XmlReader.Create(New StringReader(xmlString))
reader.ReadToFollowing("time")
Dim time As String = reader.ReadElementContentAsString()
' Read the element contents as a string and covert to DateTimeOffset type
' The format of time must be a subset of the W3C Recommendation for the XML dateTime type
Dim transaction_time As DateTimeOffset = XmlConvert.ToDateTimeOffset(time)
OutputTextBlock.Text = transaction_time.ToString()
End Using
String xmlString =
@"<?xml version='1.0'?>
<transactions>
<transaction>
<id>123456789</id>
<amount>1.00</amount>
<currency>USD</currency>
<time>2007-08-03T22:05:13-07:00</time>
</transaction>
</transactions>";
// Create an XmlReader
using (XmlReader reader = XmlReader.Create(new StringReader(xmlString)))
{
reader.ReadToFollowing("time");
string time = reader.ReadElementContentAsString();
// Read the element contents as a string and covert to DateTimeOffset type
// The format of time must be a subset of the W3C Recommendation for the XML dateTime type
DateTimeOffset transaction_time = XmlConvert.ToDateTimeOffset(time);
OutputTextBlock.Text = transaction_time.ToString();
}
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.