• Article

XAttribute Explicit Conversion (XAttribute to Boolean)

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Cast the value of this XAttribute to a Boolean.

This API is not CLS-compliant. 

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

Syntax

'Declaration
Public Shared Narrowing Operator CType ( _
    attribute As XAttribute _
) As Boolean

public static explicit operator bool (
    XAttribute attribute
)

Parameters

Return Value

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

Exceptions

Exception Condition
FormatException

The attribute does not contain a valid Boolean value.
ArgumentNullException

The attribute parameter is nulla null reference (Nothing in Visual Basic).

Remarks

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.

Examples

The following example creates an attribute with a Boolean value, then casts it to Boolean.

Dim output As New StringBuilder
Dim root As XElement = <root BoolValue="true"/>
Dim bv As Boolean = CBool(root.Attribute("BoolValue"))
output.Append(String.Format("(bool)BoolValue={0}", bv))
output.Append(Environment.NewLine)

OutputTextBlock.Text = output.ToString()

StringBuilder output = new StringBuilder();
XElement root = new XElement("Root",
    new XAttribute("BoolValue", true)
);
bool bv = (bool)root.Attribute("BoolValue");
output.Append("(bool)BoolValue=" + bv + Environment.NewLine);

OutputTextBlock.Text = output.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.