XmlReader.ReadContentAsBoolean Method (System.Xml)

ReadContentAsBoolean Method

Switch on low bandwidth view

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

.NET Framework Class Library

XmlReader..::.ReadContentAsBoolean Method

Reads the text content at the current position as a Boolean.

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

Syntax

Visual Basic (Declaration)

Public Overridable Function ReadContentAsBoolean As Boolean

Visual Basic (Usage)

Dim instance As XmlReader
Dim returnValue As Boolean

returnValue = instance.ReadContentAsBoolean()

public virtual bool ReadContentAsBoolean()

Visual C++

public:
virtual bool ReadContentAsBoolean()

JScript

public function ReadContentAsBoolean() : boolean

Return Value

Type: System..::.Boolean
The text content as a Boolean object.

Exceptions

Exception	Condition
InvalidCastException	The attempted cast is not valid.
FormatException	The string format is not valid.

Remarks

This method concatenates text, white space, significant white space, and CDATA sections, and skips any comments or processing instructions. Entity references are automatically resolved.

If the content is typed xsd:boolean, the reader returns an unboxed Boolean object. If the content is not typed xsd:boolean, the reader attempts to convert it to a Boolean object according to the rules defined by the W3C XML Schema Part 2: Datatypes recommendation.

The following table describes how this method treats each node type.

XmlNodeType	Return value	Reader behavior
Text CDATA Whitespace SignificantWhitespace EntityReference EndEntity	Concatenated content of text, CDATA, white space and significant white space nodes converted to the requested type.	Moves to the next start element or end element tag. Entity references are automatically expanded.
Attribute	Same as calling XmlConvert.ToXxx on the attribute value.	The reader remains in the current position.
Comment ProcessingInstruction	Ignores the processing instruction (PI) or comment and reads the concatenated text content that follows the PI or comment.	Moves to the next start element or end element tag. Entity references are automatically expanded.
EndElement	An empty string.	The reader remains in the current position.
Element XmlDeclaration None Document DocumentType Notation Entity DocumentFragment	An InvalidOperationException is thrown.	Undefined, although typically the reader remains in the current position.

For more information, see Reading Typed Data and the W3C XML Schema Part 2: Datatypes recommendation.

Examples

The following example uses the ReadContentAsBoolean method to read the attribute as a Boolean value.

Visual Basic

Using reader As XmlReader = XmlReader.Create("dataFile_2.xml")

  reader.ReadToDescendant("item")

  Do
    reader.MoveToAttribute("sale-item")
    Dim onSale As [Boolean] = reader.ReadContentAsBoolean()
    If onSale Then
      Console.WriteLine(reader("productID"))
    End If
  Loop While reader.ReadToNextSibling("item")

End Using

using (XmlReader reader = XmlReader.Create("dataFile_2.xml")) {
      reader.ReadToDescendant("item");
      do {
          reader.MoveToAttribute("sale-item");
          Boolean onSale = reader.ReadContentAsBoolean();
          if (onSale) {
             Console.WriteLine(reader["productID"]);
          }
      } while (reader.ReadToNextSibling("item"));    
}

The example uses the dataFile_2.xml file as input.

<root>
  <item sale-item='true' productID='123456' colors='blue green black'>
    <price>9.95</price>
  </item>
  <item sale-item='false' productID='124390'>
    <price>5.95</price>
  </item>
  <item sale-item='true' productID='53298'>
    <price>12.95</price>
  </item>
</root>

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0

.NET Compact Framework

Supported in: 3.5, 2.0

XNA Framework

Supported in: 3.0, 2.0, 1.0

Reference

XmlReader Class

XmlReader Members

System.Xml Namespace

Other Resources

Reading Typed Data