XAttribute Explicit Conversion (XAttribute to DateTime)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

equivalentCodeEntityop_Explicit(XAttribute attribute)

Cast the value of this XAttribute to a DateTime.

This API is not CLS-compliant.

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

public static explicit operator DateTime (
	XAttribute attribute
)

Parameters

attribute
Type: System.Xml.Linq.XAttribute

The XAttribute to cast to DateTime.

Return Value

Type: System.DateTime

A DateTime that contains the content of this XAttribute.

Exception Condition
FormatException

The attribute does not contain a valid DateTime value.

ArgumentNullException

The attribute parameter is null.

The value space of an attribute or element that contains date and time content is closely related to the dates and times described in ISO 8601. When creating an attribute or element that contains date and time content, the attribute or element values are formatted per the W3C specification. See the W3C specification for more details.

Behavior is lax when casting to a DateTime from an attribute or element. Even if the attribute or element value is not formatted exactly per the W3C specification, the value is appropriately converted to a DateTime.

This conversion operator uses CultureInfo.InvariantCulture to convert from a DateTime.

The following example creates an attribute with date and time content. It then casts it to DateTime to retrieve the value.


                // Behavior is strict when formatting an XML element or attribute from a DateTime,
// but behavior is lax when casting to a DateTime from an element or attribute.

XElement root = new XElement("Root",
    new XAttribute("Att", new DateTime(2006, 10, 6, 12, 30, 0))
);
Console.WriteLine(root);

// casting from a strictly formatted XML attribute
DateTime dt = (DateTime)root.Attribute("Att");
Console.WriteLine("dt={0}", dt);
Console.WriteLine("-----");

// if root is formatted in some different way than the standard ISO 8601, if at all possible,
// the value is appropriately converted to DateTime

XAttribute dtAtt = new XAttribute("OrderDate", "October 6, 2006");
Console.WriteLine(dtAtt);
DateTime orderDate = (DateTime)dtAtt;
Console.WriteLine("OrderDate={0:d}", orderDate);

This example produces the following output:


                <Root Att="2006-10-06T12:30:00" />
dt=10/6/2006 12:30:00 PM
-----
OrderDate="October 6, 2006"
OrderDate=10/6/2006

Universal Windows Platform
Available since 8
.NET Framework
Available since 3.5
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1
Return to top
Show: