BoolExpression class

Package:

adaptive-expressions

Represents a property which is either a boolean or a string expression which resolves to a boolean.

Extends

ExpressionProperty<boolean>

Remarks

String values are always interpreted as an expression, whether it has '=' prefix or not.

Constructors

BoolExpression(boolean | string | Expression)

Initializes a new instance of the BoolExpression class.

Inherited Properties

expressionText	Getes or sets the expression text to evaluate to get the value.
value	Gets or sets the raw value of the expression property.

Methods

setValue(boolean | string | Expression)

Set a boolean value.

Inherited Methods

getValue(object)	Get the value.
toExpression()	This will return the existing expression if the value is non-complex type.
toString()	Convert an expression property to string.
tryGetValue(object)	Try to Get the value.

Constructor Details

BoolExpression(boolean | string | Expression)

Initializes a new instance of the BoolExpression class.

new BoolExpression(value?: boolean | string | Expression)

Parameters

value

boolean | string | Expression

A boolean or a string expression which resolves to a boolean.

Inherited Property Details

expressionText

Getes or sets the expression text to evaluate to get the value.

expressionText: string

Property Value

string

Inherited From ExpressionProperty.expressionText

value

Gets or sets the raw value of the expression property.

value: boolean

Property Value

boolean

Inherited From ExpressionProperty.value

Method Details

setValue(boolean | string | Expression)

Set a boolean value.

function setValue(value: boolean | string | Expression)

Parameters

value

boolean | string | Expression

Value to set.

Inherited Method Details

getValue(object)

Get the value.

function getValue(data: object): boolean

Parameters

data

object

Data to use for expression binding.

Returns

boolean

The value.

Remarks

An error will be thrown if value is an invalid expression.

Inherited From ExpressionProperty.getValue

toExpression()

This will return the existing expression if the value is non-complex type.

function toExpression(): Expression

Returns

Expression

The existing expression if the value is non-complex type.

Inherited From ExpressionProperty.toExpression

toString()

Convert an expression property to string.

function toString(): string

Returns

string

The converted string.

Inherited From ExpressionProperty.toString

tryGetValue(object)

Try to Get the value.

function tryGetValue(data: object): { error: Error, value: boolean }

Parameters

data

object

Data to use for expression binding.

Returns

{ error: Error, value: boolean }

the value or an error.

Inherited From ExpressionProperty.tryGetValue