ToBool Method

Converts the specified value to a boolean value.

Syntax

Visual Basic
C#

'Declaration
 
Public Shared Function ToBool( _
   ByVal value As Object _
) As Boolean

'Usage
 
Dim value As Object
Dim value As Boolean
 
value = CalcConvert.ToBool(value)

public static bool ToBool( 
   object value
)

Parameters

value: Value to convert

Return Value

Boolean value equivalent to the specified value

Exceptions

Exception	Description
System.InvalidCastException	Value cannot be converted.

Example

This example converts the value to a boolean.

public class TrueFunctionInfo : FunctionInfo
    {
        public override string Name { get { return "TRUEIT"; } }
        public override int MinArgs { get { return 1; } }
        public override int MaxArgs { get { return 1; } }
        public override object Evaluate (object[] args)
        {
            bool b = CalcConvert.ToBool(args[0]);
            return b; 
        }
    }

Visual Basic

Public Class TrueFunctionInfo
   Inherits FarPoint.CalcEngine.FunctionInfo

   Public Overrides ReadOnly Property Name() As String
   Get
   Return "TRUEIT"
   End Get
   End Property

   Public Overrides ReadOnly Property MinArgs() As Integer
   Get
   Return 1
   End Get
   End Property

   Public Overrides ReadOnly Property MaxArgs() As Integer
   Get
   Return 1
   End Get
   End Property

   Public Overrides Function Evaluate(ByVal args() As Object) As Object
   Dim b As Boolean = FarPoint.CalcEngine.CalcConvert.ToBool(args(0))
   Return b
   End Function
End Class

Requirements

Target Platforms: Windows 7, Windows 8, Windows Vista, Windows Server 2000, Windows 2000 Professional, Windows XP Professional, Windows NT 4.0 Workstation, SP6, Windows NT 4.0 Server, SP6

Reference

CalcConvert Class
CalcConvert Members