documentation /ingredient/formIngredients

Submit-blocking validator

IngredientformIngredients

Display a message and prevent form submission if a Boolean formula fails

Ingredient Family: formIngredients

Outline Display: Display {{getText}} and prevent form submission if validation formula {{formula}} is not met.

Local scope

The parent slot binds these (look up the slot in the parent to see how):

  • $parentTable – The table (if any) that this form is based on
  • $formFieldsTable – A table of form fields that is built up through the sequence of form ingredients

Settings

Required

  • formula : formula (returns bool; required, non-nullable)
    The formula that checks form validity
    Scope: all columns of $formFieldsTable (reference as [ColumnName], e.g., [Name], [Price])

  • getText : formula (returns formatted text; required, non-nullable)
    The text to display when the user tries to submit an invalid form. Note that because the output is richtext, any math-like operators, such as IF, must be wrapped in $$…$$.
    Scope: all columns of $formFieldsTable (reference as [ColumnName], e.g., [Name], [Price])