Export (0) Print
Expand All

XElement Explicit Conversion (XElement to Boolean)

Cast the value of this XElement to a Boolean.

This API is not CLS-compliant. 

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

public static explicit operator bool (
	XElement element
)

Parameters

element
Type: System.Xml.Linq.XElement

The XElement to cast to Boolean.

Return Value

Type: System.Boolean
A Boolean that contains the content of this XElement.

ExceptionCondition
FormatException

The element does not contain a valid Boolean value.

ArgumentNullException

The element parameter is null.

When converting to Boolean from an attribute or element, allowed values are "0", "1", and any string that produces "true" or "false" after trimming and conversion to lower case.

The following example creates some elements with boolean values. It then casts them to Boolean.

XElement root = new XElement("Root", 
    new XElement("BoolValue1", true),
    new XElement("BoolValue2", false)
);
bool bool1 = (bool)root.Element("BoolValue1");
bool bool2 = (bool)root.Element("BoolValue2");
Console.WriteLine("(bool)BoolValue1={0}", bool1);
Console.WriteLine("(bool)BoolValue2={0}", bool2);

This example produces the following output:

(bool)BoolValue1=True
(bool)BoolValue2=False

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

XNA Framework

Supported in: 3.0

Portable Class Library

Supported in: Portable Class Library

Supported in: Windows Phone 8.1

Supported in: Windows Phone Silverlight 8.1

Supported in: Windows Phone Silverlight 8
Show:
© 2015 Microsoft