XPathNavigator.ValueAsBoolean Property


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

Gets the current node's value as a Boolean.

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

public override bool ValueAsBoolean { get; }

Property Value

Type: System.Boolean

The current node's value as a Boolean.

Exception Condition

The current node's string value cannot be converted to a Boolean.


The attempted cast to Boolean is not valid.

If the XPathNavigator has schema or type information (for example, from an XmlDocument object initialized with an XML schema validating XmlReader), and if the current node is defined as an XML Schema xs:boolean type, the ValueAsBoolean property returns the current node's value as an unboxed Boolean object.

However, if the XPathNavigator does not have any schema or type information, the ValueAsBoolean property attempts to convert the string value of the current node to a Boolean value, according to the XPath 2.0 casting rules for xs:boolean.

In the following example, the value of each element in the valueas.xml file is returned using the ValueAsBoolean, ValueAsDateTime, ValueAsDouble, ValueAsInt, and ValueAsLong properties.

XPathDocument document = new XPathDocument("valueas.xml");
XPathNavigator navigator = document.CreateNavigator();

// ValueAsBoolean
navigator.MoveToChild("root", "");
navigator.MoveToChild("booleanElement", "");
bool booleanValue = navigator.ValueAsBoolean;
Console.WriteLine(navigator.LocalName + ": " + booleanValue);

// ValueAsDateTime
navigator.MoveToNext("dateTimeElement", "");
DateTime dateTimeValue = navigator.ValueAsDateTime;
Console.WriteLine(navigator.LocalName + ": " + dateTimeValue);

// ValueAsDouble, ValueAsInt32, ValueAsInt64, ValueAsSingle
navigator.MoveToNext("numberElement", "");
Double doubleValue = navigator.ValueAsDouble;
Int32 int32Value = navigator.ValueAsInt;
Int64 int64Value = navigator.ValueAsLong;
Console.WriteLine(navigator.LocalName + ": " + doubleValue);
Console.WriteLine(navigator.LocalName + ": " + int32Value);
Console.WriteLine(navigator.LocalName + ": " + int64Value);

The example takes the valueas.xml file as an input.


.NET Framework
Available since 2.0
Return to top