Add a control that displays a text field that allows the Request participant to enter plain text or a password.
Control Description
The Line Input control is a text field that the Request participant can enter information. Configure the Line Input control to accept one of the following data types:
Text: The control only accepts alphanumeric characters.
Integer: The control only accepts integers.
Currency: The control only accepts a currency value.
Percentage: The control only accepts a percentage value.
Decimal: The control only accepts any number, both positive and negative.
Datetime: The control only accepts a datetime, which is includes both date and time components.
Date: The control only accepts a date.
Password: The control accepts a password. Entered text is hidden.
Permissions Required
Your user account or group membership must have the following permissions to design a Screen unless your user account has the Make this user a Super Admin setting selected:
Screens: Edit Screens
Screens: View Screens
See the Screens permissions or ask your Administrator for assistance.
to edit the selected Screen. The Screen is in Design mode.
2.
View the Screen page to which to add the control.
3.
Locate the Line Input icon
in the panel to the left of the Screen Builder canvas.
4.
Drag the Line Input icon into the Screen Builder canvas. Existing controls on the Screen Builder canvas adjust positioning based on where you drag the control.
5.
Place into the Screen Builder canvas where you want the control to display on the Screen.
After adding a control to a Screen page, you may move it to another location on that page such that it is above or below other controls placed on that page. A control cannot be moved to another Screen page.
Follow these steps to move a control to another location on that Screen page:
1.
Place your cursor anywhere on the control not displaying the Duplicate Control
or Delete Control
buttons.
2.
Hold your cursor, then drag the control above or below other controls on that Screen page. Screen Builder previews where the control would display on the page based on how you position the control above or below other controls. If the control cannot be placed in a location because your cursor is above an existing control or too far to the left or right of the page, the
icon displays in the preview.
3.
Place the control at the location on the page you want it. The other control(s) on the page automatically adjust position.
Copy the Control with its Settings
Copying a control also copies the current settings of that control. The copied control displays below other controls placed on that Screen page.
. The control copies with its current settings, and then displays below other controls placed on that page.
As a best practice, after copying a control, change the Variable Name setting value for the copied control to its own unique variable value. Otherwise, in-progress Requests that use this Screen read from and send data to both controls.
Edit the default Variable Name setting value for this control if necessary. The Variable Name setting value represents data in this control during Requests. Ensure that the Variable Name setting value is a unique name from other controls in this Screen and contains at least one letter. This is a required setting.
Use the Variable Name setting value in the following ways:
Reference this control by its Variable Name setting's value. The Data Preview panel in Preview mode corresponds the Line Input control's textual content with that Line Input control's Variable Name value. In the example below, LineInputControl is the Variable Name setting's value.
Reference this control's value in a different Screen Builder control. To do so, use mustache syntax and reference this control's Variable Name value in the target control. Example: {{ LineInputControl }}.
Select one of the following data type options this control accepts when the Request participant enters content into this control:
Text: The control only accepts alphanumeric characters. Text is the default setting.
Integer: The control only accepts integers.
Currency: The control only accepts a currency value.
Percentage: The control only accepts a percentage value.
Decimal: The control only accepts any number, both positive and negative.
Datetime: The control only accepts a datetime, which is includes both date and time components.
Date: The control only accepts a date.
Password: The control accepts a password. Entered text is hidden.
This is a required setting.
The following message displays below the control if the Request participant enters content that does not comply with this control's data type: The format is invalid..
Validation Rules
Enter the validation rule(s) the Request participant must comply with to properly enter a valid value into this control. This setting has no default value. If there are no configured validation rules the following message displays: No validation rule(s). See Validation Rules for "Validation" Control Settings.
Follow these steps to add a validation rule to this control:
Click the Add Rule button. The Select drop-down menu displays.
3.
Select the rule that this control validates against.
4.
Click Save. Parameters for the selected rule display. Parameter settings display which ones are required to properly configure the rule.
5.
Enter the parameter settings that this control uses to validate against. See Validation Rule Settings, and then locate the validation rule for its parameters.
Follow these steps to edit a validation rule for this control:
for the validation rule to edit if that rule can be edited. Validation rules that do not have parameters cannot be edited. The parameter settings for that validation rule displays.
3.
Edit the parameter settings that this control uses to validate against. See Validation Rule Settings, and then locate the validation rule for its parameters.
Follow these steps to delete a validation rule for this control:
Enter the default value this control displays. If the Default Value setting has no value, then this control does not display a value when the Screen displays. When the Screen submits, the Request uses this control's default value unless the Request participant changes it. The Default Value setting supports mustache syntax as the default value. For example, if the Default Value setting is {{ FirstName }} {{ LastName }} from which a Request participant entered her first name and last name in separate controls (respectively) earlier in that Request, this control displays the contents of those controls by default during the Request.
There are two ways to enter the default value this control displays.
Enter the default value as text (default)
Enter the default value as JavaScript
Enter the default value as text.
Enter the default value as JavaScript, especially if a Calculated Property might change this default value setting. Ensure to use the this. JavaScript keyword preceding the Screen control reference. Example: this.FullName when FullName is the Variable Value setting value for the control to set its default value.
Note the following regarding how to use visibility rules:
To make this control hidden until another control contains a value, enter the Variable Name setting value of that control to this control's Visibility Rule setting.
Enter a mask pattern to require a custom input format. If this setting does not have a mask pattern, then this control adds plain text without formatting.
Date, SSN and Phone mask pattern display as examples.
Use the following mask components to compose your mask pattern:
Token
Pattern
#
Positive integer values [0-9]
X
[0-9a-zA-Z]
S
[a-zA-Z]
A
All text convert to upper case
a
All text convert to lower case
!
Set undefined value
Examples
Set the Social Security Number (SSN) using the mask pattern ###-##-####. Then, the Line Input control only allows numeric values with that pattern.
Set a US phone number using the mask pattern +1 (###) ###-####. Then, the Line Input control only allows numeric values preceding the US telephone code by default.
Set a car license plate that complies with the format for a specific US state, such as AAA ###. Then, the Line Input control only allows upper case alphabetic characters followed by numeric values.
The Data Preview panel displays the entered text without the mask patterns.
This custom format input overrides any other formatting set by default, including the one described when using scripts.
CSS Selector Name
Enter the value to represent this control in custom CSS syntax when in Custom CSS mode. As a best practice, use the same CSS Selector Name value on different controls of the same type to apply the same custom CSS style to all those controls.
See the following best practices regarding custom CSS in Screens: