Properties of a Button control

Use the following tabs to configure the properties of a Button control.

General

Name Description

Type

The type of the control.

Name

A unique name for the button.

Tooltip

The supplementary information that displays by hovering the mouse over the button at runtime.

For example, click the professional details button to enter your professional experience.

Enabled

Enables the control at runtime. (Default: Selected)

Security token

Makes the information in the form secure. See Security tokens.

Text

Meaningful text that appears at runtime. For example, "Click to update personal details" instead of "button 1".

Visible

Makes the control visible at runtime. (Default: Selected)

Load image from store

When selected (default), allows you to select an image in the Image path field.

If clear, allows you to enter an image name in the Image path field.

For on-premise TotalAgility, the image needs to reside in the following location: <Installation location>\Kofax\TotalAgility\Agility.Server.Web\Forms\Images

Resize to fit

If selected, allows the image to be resized to fit the button frame. Otherwise, uses the original size. (Default: Clear)

Causes validation

Indicates whether the button causes validation to be performed on any controls that require validation. (Default: Selected)

If an error occurs while validating the controls, then the button does not fire its event.

Show validation summary

Indicates whether to display the list of invalid fields at runtime. This is specifically helpful when the invalid fields are within a collapsed panel or tabs, or tabs within collapsed panels that do not currently have focus.

Showing validation summary displays error messages for invalid fields. Each error message is a link, which when clicked, sets focus to the invalid field so that you can correct the error. If the invalid field is in a collapsed panel, the panel expands. If the invalid field is in a tab, the tab is displayed.

After fixing the errors, if you click the button again, the validation summary is refreshed and displays the outstanding errors, if any.

The Show validation summary property is only available if the Causes validation property is selected, and it only applies to non-touch forms.

Confirmation message

A confirmation message to display when the button is clicked.

A confirmation message can prevent the user from accidentally performing an action that may result in data loss.

For example, when the user clicks the 'Delete customer' button by mistake, it could delete the customer and all associated data from the system without having a chance to undo the action. But you can prevent that mistake by setting the following confirmation message by clicking the button: "Are you sure you want to delete the customer account details? Click Cancel to stop the deletion. Click Yes to confirm the deletion."

Specify the message using a dynamic or a static value.

  • Form control: The selected form field appears at runtime, where you can enter the message.
  • Form variable: The message saved in the form variable is available for use with this form; however, you can change the message by changing the variable value.
  • Global variable: The message is available for use in different forms within a site. If you change the value of the variable, the change is applied to all forms that use this variable.

Submit button

If selected, the actions associated with a specific button execute when you press the Enter key. (Default: Clear)

You can use only one Submit button on a form. If you try to use another one, the following error message appears: Only one Submit button can be set on a form.

The Submit button property on the Complete button on an Activity form or Multiview activity forms, the Submit button on the Create new job form, and the Log in button on the Logon form are selected by default. This means that when you press the Enter key on these forms, the respective actions execute.