true() Function

Function

true( returns )

Returns the Boolean value true.

See also:

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

Parameters

Returns

Boolean

Usage considerations

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

In addition, it isn't necessary to compare a condition to true—the result of a conditional statement can be used directly.

For example, this expression will return "Yes":

1
2
3
4
5
if(
  a!isUserMemberOfGroup(cons!MY_GROUP) = true(),
  "Yes",
  "No"
)

However, the following expression returns the same output:

1
2
3
4
5
if(
  a!isUserMemberOfGroup(cons!MY_GROUP),
  "Yes",
  "No"
)

Examples

Basic example

true() returns true

Using true() as a Boolean status

1
2
3
4
5
6
7
8
9
10
11
12
a!localVariables(
  local!status1: true(),
  local!status2: false(),
  local!status3: true(),
  where(
    {
      local!status1,
      local!status2,
      local!status3
    }
  )
)

Returns {1, 3} because the first and third status are true.

Using true() for field configurations

Paste this example into an interface to see the result.

1
2
3
4
5
6
7
8
9
10
11
a!localVariables(
  local!value,
  a!textField(
    label: "Text",
    value: local!value,
    saveInto: local!value,
    required: true(),
    characterLimit: 25,
    showCharacterCount: true()
  )
)

When configuring components, use true() to set a fixed value for Boolean properties.

Feature compatibility

Feedback