false() Function

Function

Copy link to clipboard

false( returns )

Returns the Boolean value false.

See also:

• if(): Evaluates a logical statement and returns different results if the logical statement returns true or false.
• true(): The opposite to the false() function; returns the boolean value true.

Parameters

Copy link to clipboard

Returns

Copy link to clipboard

Boolean

Usage considerations

Copy link to clipboard

Using the false() function is equivalent to using false (without calling the function) in any expression. If calling the false() function with parentheses, any parameters provided to the function are ignored.

An easy way to check if a value is either null or true is to make a comparison to false using the <> operator. For example, the following expressions result in the same outcome:

• local!value <> false()
• or(local!value = true(), a!isNullOrEmpty(local!value))

Examples

Copy link to clipboard

Basic example

Copy link to clipboard

1
false()
Copy

Returns false.

Using false() as a user property

Copy link to clipboard

1
2
3
4
5
6
7
8
9
10
a!localVariables(
  local!user1Active: false(),
  local!user2Active: false(),
  local!user3Active: true(),
  and(
    local!user1Active,
    local!user2Active,
    local!user3Active
  )
)
Copy

Returns false because not all of the users are currently active.

Using false() for field configurations

Copy link to clipboard

Paste the following example into an interface to test the expression.

1
2
3
4
5
6
7
8
9
10
11
12
a!boxLayout(
  label: "Box",
  contents: {
    a!textField(
      value: "Test",
      readOnly: true()
    )
  },
  isCollapsible: false(),
  showBorder: false(),
  showShadow: false()
)
Copy

Feature compatibility

Copy link to clipboard

Feedback

Copy link to clipboard