Convert.ToBoolean Method (Object, IFormatProvider)

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Converts the value of the specified Object to an equivalent Boolean value using the specified culture-specific formatting information.

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

Syntax

'Declaration
Public Shared Function ToBoolean ( _
    value As Object, _
    provider As IFormatProvider _
) As Boolean
public static bool ToBoolean(
    Object value,
    IFormatProvider provider
)

Parameters

Return Value

Type: System.Boolean
true or false, which reflects the value returned by invoking the ToBoolean method for the underlying type of value. If value is nulla null reference (Nothing in Visual Basic), the method returns false.

Exceptions

Exception Condition
InvalidCastException

value does not implement the IConvertible interface.

Remarks

provider enables the user to specify culture-specific conversion information about the contents of value. For example, if value is a String that represents a number, provider could supply culture-specific information about the notation used to represent that number.

The base types ignore provider; however, it is honored if value is a user-defined type that implements the IConvertible interface.

Version Information

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

XNA Framework

Supported in: Xbox 360, Windows Phone OS 7.0

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.