Convert.ToBoolean(Convert)

Converts data to a Boolean data type with a value of true or false.

Applies To

Description

Converts data to a Boolean data type with a value of true or false. This converts any data type into a Boolean. There are limitation on how this works.

Numbers: any number not equal to 0 will evaluate to true. Zero will evaluate to false.

Text: the words 'Yes' and 'True', regardless of capitalization will evaluate to true, all other text will evaluate to false.

Dates, Arrays, and Objects: will evaluate to false.

Properties and Methods

None

Available

The .ToBoolean(Convert) method is available in:

  • 15.03.016

  • All newer builds

Type

Boolean

Syntax

Convert.ToBoolean(Convert);

Parameters

Parameter

Required

Description

Convert Yes Any data type and value that can convert to a Boolean data type

Example

Event.Form.MessageBox('Non-zero number: ' + Convert.ToBoolean(0.000001) +

'\nNon-zero number: ' + Convert.ToBoolean(20) +

'\nNon-zero number: ' + Convert.ToBoolean(-2) +

'\nZero: ' + Convert.ToBoolean(0) +

'\nYes: ' + Convert.ToBoolean('Yes') +

'\nTrue: ' + Convert.ToBoolean('True') +

'\nOther Text: ' + Convert.ToBoolean('JavaScript') +

'\nDate: ' + Convert.ToBoolean(DateTime.Now) +

'\nArray: ' + Convert.ToBoolean([1, 2, 3]) +

'\nObject: ' + Convert.ToBoolean({}));

 

/*Expected System Prompt Display

Non-zero number: true

Non-zero number: true

Non-zero number: true

Zero: false

Yes: true

True: true

Other Text: false

Date: false

Array: false

Object: false

*/