Convert.ToBoolean Method (String)
Converts the specified string representation of a logical value to its Boolean equivalent.
Namespace: System
Assembly: mscorlib (in mscorlib.dll)
Parameters
- value
- Type: System.String
A string that contains the value of either Boolean.TrueString or Boolean.FalseString.
Return Value
Type: System.Booleantrue if value equals TrueString, or false if value equals FalseString or null.
| Exception | Condition |
|---|---|
| FormatException | value is not equal to TrueString or FalseString. |
For a successful conversion to occur, the value parameter must equal either Boolean.TrueString, a constant whose value is True, Boolean.FalseString, a constant whose value is False, or it must be null. In comparing value with Boolean.TrueString and Boolean.FalseString, the method ignores case as well as leading and trailing white space.
If you prefer not to handle an exception if the conversion fails, you can call the Boolean.TryParse method instead. It returns a Boolean value that indicates whether the conversion succeeded or failed.
The following example uses the Convert.ToBoolean(String) method to convert various strings to Boolean values.
using System; public class BooleanConversion { public static void Main() { ConvertToBoolean(null); ConvertToBoolean(String.Empty); ConvertToBoolean("true"); ConvertToBoolean("TrueString"); ConvertToBoolean("False"); ConvertToBoolean(" false "); ConvertToBoolean("-1"); ConvertToBoolean("0"); } private static void ConvertToBoolean(string value) { try { Console.WriteLine("Converted '{0}' to {1}.", value, Convert.ToBoolean(value)); } catch (FormatException) { Console.WriteLine("Unable to convert '{0}' to a Boolean.", value); } } } // The example displays the following output to the console: // Converted '' to False. // Unable to convert '' to a Boolean. // Converted 'true' to True. // Unable to convert 'TrueString' to a Boolean. // Converted 'False' to False. // Converted ' false ' to False. // Unable to convert '-1' to a Boolean. // Unable to convert '0' to a Boolean.
Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
