Submit Button Control Settings

Add a control from which the Request participant submits the Screen.

Control Description

The Submit Button control adds a button to the Screen. The Submit Button control has two functions:

• Submit: Submits the Screen whilst setting this control's value as specified from the Value setting. This is the default setting.

• Do Not Submit, Set Value: Sets this control's value as specified from the Value setting, but does not submit the Screen.

This control is only available for Form-type Screens. See Screen Types.

See how to configure a Submit Button control that prevents the Request participant from clicking on that control multiple times so the Screen cannot be submitted after the first click.

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.

Add the Control to a Screen

Permissions Required

Permissions are required to do this.

Design Best Practice

Avoid designing with more than 25 controls in one Screen.

Follow these steps to add this control to the Screen:

1. Create a new Screen or click the Edit iconto edit the selected Screen. The Screen is in Design mode.
2. View the Screen page to which to add the control.

3. Locate the Submit Button iconin the panel to the left of the Screen Builder canvas.
4. Drag the Submit Button 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.

   
6. Configure the Submit Button control. See Settings.

7. Validate that the control is configured correctly. See Validate Your Screen.

Below is a Submit Button control in Preview mode.

Submit Button control in Preview mode using the "Primary" Variant option

Move the Control on the Page

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.

Permissions are required to do this.

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 Controlor Delete Controlbuttons.
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, theicon 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.

Permissions are required to do this.

Follow these steps to copy a control:

1. Select the control to be copied.

2. Click the Duplicate Control button. 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.

Delete the Control from a Screen

Permissions are required to do this.

Deleting a control also deletes configuration for that control. If you add another control, it will have default settings.

Follow these steps to delete a control from a Screen page:

1. Select the control to be deleted.

2. Click the Delete button. The control deletes. Other controls on that Screen page adjust their locations automatically.

Settings

Permissions are required to do this.

The Submit Button control has the following panels that contain settings:

• Variable panel

• Configuration panel

• Design panel

• Advanced panel

Variable Panel Settings

Click the control while in Design mode, and then click the Variable panel that is on the right-side of the Screen Builder canvas.

Below are settings for the Submit Button control in the Variable panel:

• Variable Name

• Label

• Value

Variable Name

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 Submit Button control's Variable Name value. In the example below, SubmitButtonControl is the Variable Name setting's value when the button is clicked.
• 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: {{ SubmitButtonControl }}.

• Reference this value in Visibility Rule setting expressions.

See best practices when editing a Request variable name.

Label

Edit the default label that displays for this control if necessary. New Submit is the default value.

Value

Enter any alphanumeric value that represents data when the Request participant selects the Submit Button control. This value can be evaluated in a Visibility Rule setting expression or in a Sequence Flow element's condition(s) to trigger.

See how to configure a Submit Button control that prevents the Request participant from clicking on that control multiple times so the Screen cannot be submitted after the first click.

Configuration Panel Settings

Click the control while in Design mode, and then click the Configuration panel that is on the right-side of the Screen Builder canvas.

Below are the settings for the Submit Button control in the Configuration panel:

• Type Button

• Tooltip

Type Button

Select from the following options how the Submit Button control functions when the control is clicked:

• Submit: Submits the Screen whilst setting this control's value as specified from the Value setting. This is the default setting.

• Do Not Submit, Set Value: Sets this control's value as specified from the Value setting, but does not submit the Screen.

Tooltip

Configure a tooltip that displays when hovering over the Submit Button control.

Follow these steps to configure how the tooltip displays for the Submit Button control:

1. From the Position drop-down menu, select the position of the tooltip relative to the Submit Button control from the following options:

   • Top

   • Top Left

   • Top Right

   • Right

   • Right Top

   • Right Bottom

   • Bottom

   • Bottom Left

   • Bottom Right

   • Left

   • Left Top

   • Left Bottom

2. From the Variant drop-down menu, select the style for the tooltip:

   • Primary: Blue-colored background with white-colored Label text. This is the default option.

   • Secondary: Gray-colored background with white-colored Label text.

   • Success: Green-colored background with white-colored Label text.

   • Danger: Red-colored background with white-colored Label text.

   • Warning: Yellow-colored background with black-colored Label text.

   • Info: Teal-colored background with white-colored Label text.

   • Light: White-colored background with black-colored Label text.

   • Dark: Black-colored background with white-colored Label text.

3. In the Tooltip Contains setting, enter the text that the tooltip displays. This setting supports both HTML and mustache syntax.

Design Panel Settings

Click the control while in Design mode, and then click the Design panel that is on the right-side of the Screen Builder canvas.

Below is the setting for the Submit Button control in the Design panel:

• Button Variant Style

Button Variant Style

Select the style for the Submit Button control. The style changes the control's appearance but otherwise has no functional difference. Select from the following options:

• Primary: Blue-colored background with white-colored Label text. This is the default option.

• Secondary: Gray-colored background with white-colored Label text.

• Success: Green-colored background with white-colored Label text.

• Danger: Red-colored background with white-colored Label text.

• Warning: Yellow-colored background with black-colored Label text.

• Info: Teal-colored background with white-colored Label text.

• Light: White-colored background with black-colored Label text.

• Dark: Black-colored background with white-colored Label text.

• Link: White-colored background with blue-colored Label text.

Advanced Panel Settings

Click the control while in Design mode, and then click the Advanced panel that is on the right-side of the Screen Builder canvas.

Below are settings for the Submit Button control in the Advanced panel:

• Visibility Rule

• CSS Selector Name

• Aria Label

• Tab Order

Visibility Rule

Specify an expression that indicates the condition(s) under which this control displays. See Expression Syntax Components. If this setting does not have an expression, then this control displays by default.

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.

• Visibility rules override custom CSS settings.

See how to configure a Submit Button control that prevents the Request participant from clicking on that control multiple times so the Screen cannot be submitted after the first click.

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:

• Editing a CSS name to represent this control in custom CSS syntax

• Visibility rules override custom CSS settings

Aria Label

Enter the string that provides a text alternative to this control for the following purposes:

• Assistive technology, such as screen readers, read the Aria Label setting value.

• This control has a visual indication of its purpose, such as a button that uses a graphic instead of text, but still needs to clarify that purpose for anyone who cannot access the visual indication.

The Aria Label setting value replaces the Label setting value. For example, if a Submit Button control has both a Label setting value and an Aria Label setting value, assistive technology only uses the Aria Label setting value.

Tab Order

Tab order determines the sequential navigation order to navigate a Screen's controls using a keyboard interface. Assistive technology users often use a keyboard for navigation.

See best practices for setting the tab order for a Screen's controls.

Enter the number for the sequential keyboard navigation order that this control takes focus amongst other controls in this Screen.

Related Topics

pageScreen TypespageScreen Builder ModespageValidate Your ScreenpageEdit Your ScreenpageCheckbox Control SettingspageDate Picker Control SettingspageFile Download Control SettingspageFile Preview Control SettingspageFile Upload Control SettingspageGoogle Places Control SettingspageImage Control SettingspageLine Input Control SettingspageLoop Control SettingspageMulticolumn / Table Control SettingspageNested Screen Control SettingspagePage Navigation Control SettingspageRecord List Control SettingspageRich Text Control SettingspageSelect List Control SettingspageSignature Control SettingspageTextarea Control SettingspageExpression Syntax ComponentspageValidation Rules for "Validation Rules" SettingspageReference Magic Variables in ProcessMaker Platform Assets