Loop Control
Add a Loop control that contains multiple controls that loop multiple times to allow entering multiple items, each of which requires multiple pieces of information.
Control Description
Use the Loop control to contain one or more Screen controls to duplicate the contained set of controls a specified number of times, thereby minimizing the design work to duplicate that set of controls in a Screen. Use the Loop control when the Request participant must enter multiple instances of the same set of information, each of which contain multiple components.
For example, use a Loop control when a university registrar's office must enter the following information for each new university student enrolling to the university:
Information | Screen Control |
First Name | Line Input control |
Last Name | Line Input control |
Age | Line Input control |
Sex | Select List control |
Housing Dormitory | Select List control |
During the in-progress Request, the Loop control displays the set of controls contained in the Loop control a specified number of times so that the university registrar's office may enter the same information for each new student from one Screen page. The Submit Button control to submit the Screen must be placed outside of the Loop control. Otherwise, a Submit Button control displays in each set of controls placed into the Loop control.
Do not place another Loop control inside the first Loop control.
Use the _parent
JSON Key to Reference Request Data from Controls in a Loop Control
_parent
JSON Key to Reference Request Data from Controls in a Loop ControlThe Loop control uses a unique JSON key available to any control placed within the Loop control to reference Request data. Controls that are placed into a Loop control for duplication are within a container and may only access another control's data that is in the same Loop control. Use the _parent
JSON key in a control's settings placed within a Loop control to reference Request data outside of that Loop control.
The _parent
JSON key only applies to controls placed into a Loop control or Record List control.
Consider the following examples:
A Line Input control placed within a Loop control requires a default value to display from another Line Input control used during that Request of which its Variable Name setting is
Line_Input_Data
. From the Line Input control placed within the Loop control, enter the following into the Default Value setting:{{ _parent.Line_Input_Data }}
.A Select List control placed within a Loop control requires its options to display from another Select List control's options used during that Request of which its Variable Name setting is
Select_List_Options
. While configuring the Select List control placed within the Loop control to use Request data as its data source, enter the following into the Options Variable setting:_parent.Select_List_Options
.
This control is only available for the following Screen types:
Display type
Form type
See Screen Types.
Watch the following product tour to learn how to use a Loop control.
For a documented example of using the Loop control, see Loop and File Upload Controls to Limit Uploaded Files.
Add the Control to a Screen
Follow these steps to add this control to the Screen:
Configure the Loop control. See Settings.
Drag and place the Screen control(s) into the Loop control that you intend the Request participant to enter information each time the Loop control repeats. As a best practice, do not do the following:
Do not place a Submit Button control inside the Loop control.
Do not place another Loop control inside the first Loop control.
See Control Description for an example.
Configure each control placed into the Loop control. If a control placed into the Loop control requires to use Request data, use the
parent
JSON key. See Use theparent
JSON Key to Reference Request Data from Controls in a Loop Control.Validate that the control is configured correctly. See Validate Your Screen.
Below is a Loop control containing two controls, repeating twice.
Settings
The Loop control has the following configurable settings in the Properties Panel:
Configuration Panel Settings
Expand the Configuration panel from the Properties Panel on the right to configure the following properties:
Advanced Panel Settings
Expand the Advanced panel from the Properties Panel on the right to configure the following properties:
Last updated