Information
Switch
Switch
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

Convert::ToBoolean Method (Object^)

.NET Framework (current version)
 

Converts the value of a specified object to an equivalent Boolean value.

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

C#
C++
F#
VB
Copy 
public:
static bool ToBoolean(
	Object^ value
)

Parameters

value
Type: System::Object^

An object that implements the IConvertible interface, or null.

Return Value

Type: System::Boolean

true or false, which reflects the value returned by invoking the IConvertible::ToBoolean method for the underlying type of value. If value is null, the method returns false.

Exception Condition
FormatException

value is a string that does not equal TrueString or FalseString.

InvalidCastException

value does not implement the IConvertible interface.

-or-

The conversion of value to a Boolean is not supported.

The following example converts an array of object values to Boolean values.

C#
C++
VB
Copy 
array<Object^>^ objects = gcnew array<Object^> { 16.33, -24, 0, "12", "12.7", String::Empty, 
                                                "1String", "True", "false", nullptr, 
                                                gcnew System::Collections::ArrayList };

for each (Object^ obj in objects)
{
   Console::Write("{0,-40}  -->  ", 
                 obj == nullptr ? "null" :
                 String::Format("{0} ({1})", obj, obj->GetType()->Name));
   try {
      Console::WriteLine("{0}", Convert::ToBoolean((Object^) obj));
   }   
   catch (FormatException^) {
      Console::WriteLine("Bad Format");
   }   
   catch (InvalidCastException^) {
      Console::WriteLine("No Conversion");
   }   
}     
// The example displays the following output:
//       16.33 (Double)                            -->  True
//       -24 (Int32)                               -->  True
//       0 (Int32)                                 -->  False
//       12 (String)                               -->  Bad Format
//       12.7 (String)                             -->  Bad Format
//        (String)                                 -->  Bad Format
//       1String (String)                          -->  Bad Format
//       True (String)                             -->  True
//       false (String)                            -->  False
//       null                                      -->  False
//       System.Collections.ArrayList (ArrayList)  -->  No Conversion

Universal Windows Platform
Available since 8
.NET Framework
Available since 1.1
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1
Return to top
Show: