Skip navigation links
Expressively and easily automate your text documents with TExpressive!
Menu
TExpressive
Expressively and easily automate your text documents with TExpressive!

While function

Processes content while a given condition holds.

Remarks

  • The "While" function can either check if a parameter is set or not, or compare a value in a given way to another value.
  • The content in "Do" is repeated while the test holds, so possibly even never at all.
  • If you specify one of the "Is..." arguments you also have to specify the "What" argument.

Arguments

Not (optional flag)
Negate the test.
ParamSet (optional)
Test if the specified parameter is set.
ParamNotSet (optional)
Test if the specified parameter is not set.
What (optional)
The value to compare.
Is (optional)
The value to compare to.  Tests if "What" is equal to "Is".
IsNot (optional)
The value to compare to.  Tests if "What" is not equal to "IsNot".
IsLowerThan (optional)
The value to compare to.  Tests if "What" is lower than "IsLowerThan".
IsLowerThanEq (optional)
The value to compare to.  Tests if "What" is lower than or equal to "IsLowerThanEq".
IsGreaterThan (optional)
The value to compare to.  Tests if "What" is greater than to "IsGreaterThan".
IsGreaterThanEq (optional)
The value to compare to.  Tests if "What" is greater than or equal to "IsGreaterThanEq".
CaseSensitive (optional flag)
Whether TExpressive should treat upper and lower case letters differently (TExpressive treats them equally by default).
LoopNumber (optional)
The name of the parameter that receives the looping number counter.
Do
The content to repeat while the condition holds.  May of course also contain literal text or a parameter reference.