Spread Windows Forms 6.0 Product Documentation
ToBool Method
See Also  Example Support Options
FarPoint.CalcEngine Assembly > FarPoint.CalcEngine Namespace > CalcConvert Class : ToBool Method


value
Value to convert

Glossary Item Box

Converts the specified value to a boolean value.

Syntax

Visual Basic (Declaration) 
Public Shared Function ToBool( _
   ByVal value As Object _
) As Boolean
Visual Basic (Usage)Copy Code
Dim value As Object
Dim value As Boolean
 
value = CalcConvert.ToBool(value)
C# 
public static bool ToBool( 
   object value
)

Parameters

value
Value to convert

Return Value

Boolean value equivalent to the specified value

Exceptions

ExceptionDescription
System.InvalidCastExceptionValue cannot be converted.

Example

This example converts the value to a boolean.
C#Copy Code
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 BasicCopy Code
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 Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

See Also

© 2002-2012 ComponentOne, a division of GrapeCity. All Rights Reserved.