Submit Link

Function

a!submitLink( label, confirmMessage, confirmButtonStyle, value, saveInto, skipValidation, validationGroup, confirmHeader, confirmButtonLabel, cancelButtonLabel, showWhen )

Defines a link to trigger form submission. Links can be used in charts, grids, hierarchy browsers, images, link fields, milestones, pickers, and rich text.

See also:

Parameters

Name Keyword Types Description

Label

label

Text

Text associated with this link.

Confirmation Message

confirmMessage

Text

Text to display in an optional confirmation dialog box where a null argument disables the confirmation dialog box and a text argument enables it with the text entered as the confirmation message.

Confirmation Button Style

confirmButtonStyle

Text

Determines the style of the primary button in the confirmation dialog. Valid values: "PRIMARY" (default),"DESTRUCTIVE".

Value

value

Any Type

Value to be saved when the link is clicked.

Save Value To

saveInto

List of Save

One or more variables that are updated with the link value when the user clicks it. Use a!save() to save a modified or alternative value to a variable.

Skip Validation

skipValidation

Boolean

When true, submit without performing validation. Default: false.

Validation Group

validationGroup

Text

When present, this field is only validated when a button in the same validation group is clicked.

Confirmation Header

confirmHeader

Text

Text to display at the top of the confirmation dialog.

Confirm Button Label

confirmButtonLabel

Text

Text to display on the confirm button. Default: "Yes".

Cancel Button Label

cancelButtonLabel

Text

Text to display on the cancel button. Default: "No".

Visibility

showWhen

Boolean

Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default: true.

Usage considerations

Primary and secondary buttons

  • In the confirmation dialog there are two buttons. The confirm button is in the primary position and the cancel button is in the secondary position.
  • The cancel button is always "SECONDARY" style.

Saving values

  • If confirmationHeader and confirmationMessage are null, the interface refreshes and the saveInto state change occurs once the user clicks the link. If either is not null, the confirmation dialog box displays. The interface only refreshes and the saveInto state change only occurs if the user clicks the confirm button.

Examples

Copy and paste an example into the INTERFACE DEFINITION in EXPRESSION MODE to see it displayed.

Confirmation dialog

1
2
3
4
5
6
7
8
9
10
11
12
a!linkField(
  links: {
    a!submitLink(
      label: "Delete Request",
      confirmHeader: "Warning!",
      confirmMessage: "This request will be permanently deleted. Do you want to continue?",
      confirmButtonLabel: "Delete Request",
      confirmButtonStyle: "DESTRUCTIVE",
      cancelButtonLabel: "Cancel"
    )
  }
)

Displays the following when clicked:

screenshot of a confirmation dialog

Open in Github

On This Page

FEEDBACK