Information
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 (String)

Converts the specified String representation of a logical value to its Boolean equivalent.

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

public static bool ToBoolean (
	string value
)
public static boolean ToBoolean (
	String value
)
public static function ToBoolean (
	value : String
) : boolean
Not applicable.

Parameters

value

A String that contains the value of either TrueString or FalseString.

Return Value

true if value equals TrueString, or false if value equals FalseString or a null reference (Nothing in Visual Basic).

Exception typeCondition

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 a null reference (Nothing in Visual Basic). In comparing value with Boolean.TrueString and Boolean.FalseString, the method ignores case as well as leading and trailing white space.

The following example uses the Convert.ToBoolean(String) method to convert various strings to Boolean values.

Windows 98, Windows Server 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0

XNA Framework

Supported in: 1.0
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

Show:
© 2014 Microsoft