Export (0) Print
Expand All

XAttribute Narrowing Conversion (XAttribute to Boolean)

Cast the value of this XAttribute to a Boolean.

This API is not CLS-compliant. 

Namespace:  System.Xml.Linq
Assemblies:   System.Xml.Linq (in System.Xml.Linq.dll)
  System.Xml.XDocument (in System.Xml.XDocument.dll)

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

Parameters

attribute
Type: System.Xml.Linq.XAttribute

The XAttribute to cast to Boolean.

Return Value

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

ExceptionCondition
FormatException

The attribute does not contain a valid Boolean value.

ArgumentNullException

The attribute parameter is Nothing.

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 an attribute with a Boolean value, then casts it to Boolean.

Dim root As XElement = <root BoolValue="true"/>
Dim bv As Boolean = CBool(root.Attribute("BoolValue"))
Console.WriteLine("(bool)BoolValue={0}", bv)

This example produces the following output:

(bool)BoolValue=True

.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