State

Category: Field

Version: 1.0

Last Updated: March 18, 2026

Author: Any2Info


Description

The State field allows a form to take on a certain state. Defined by the States section in the a FormDefinition.

A State dictates what can happen with the form. Whether it is allowed to be saved or not.


General Properties

The State field inherits general Field Properties such as ‘Font size’, ‘Font color’ and ‘Icon color’.


Special Properties

The File field has a few special properties unique to it. These include:

Name
Value
Explanation

State

State

The value is a state list created in the FormDefinition

Selected color

Color

A color value that indicates which of the State property values is selected currently

Display type

Set list of: List, Checkbox list, Radio list, Dropdown

How the state will look like when seen in the viewer


Tips & Best Practices

  • Give the states in the list a proper DisplayText, otherwise it may not be clear what each value is.

  • If the form states are determined through a different means than direct editing, try hiding the State field and set the Value of the field through an ActionFlow.


Examples

Below is the most basic example of a State field

If the form is saved with “Open” selected, it will remain editable.

However if we decide to try and save the form with the “Closed” option selected, the following prompt will show:

The same goes for the “Closed for user” option.

If the State field is selected as a FormOverview field it will display the colors that are set in the State list, below is a simple example of “Closed for user”, “Open” and “Closed”.

States may also be edited outside the confines of the Viewers. Such as when using the Export to Form node.


Changelog

Version

Date

Change

1.0

March 18, 2026

Initial document & documentation

Last updated

Was this helpful?