Link Component

SAIL Function: a!linkField()

Display one or more links of any link type, including document links, task links, record view links, external web page links, and dynamic links that update variables.

Avoid using this component for offline mobile forms because links do not execute when tapped offline.

See also: Link Types

Parameters

Name Keyword Type Description
Label label Text Optional text to display as the field label for the list of links.
Label Position labelPosition Text Optional text to determine where the label appears. Valid values include
  • "ABOVE" (default) Displays the label above the component.
  • "ADJACENT" Displays the label to the left of the component.
  • "COLLAPSED" Hides the label. The label will still be read by screen readers; see accessibility considerations for more information.
If you set label position to `"ADJACENT"` or `"ABOVE"`, but do not give a value for label, a space still displays to the left-side or above, respectively, of the component as if there was a label displayed. To ensure the component appears to the far left when label has no value, use `"COLLAPSED"` for label position.
Instructions instructions Text Optional text displayed beneath the link(s).
Help Tooltip helpTooltip Text Displays a help icon with the specified text as a tooltip. The tooltip displays a maximum of 500 characters. The help icon does not show when the label position is "COLLAPSED".
Links links Array of Links Array of values determining which links to display. Create links with a!documentDownloadLink(), a!dynamicLink(), a!newsEntryLink(), a!processTaskLink(), a!recordLink(), a!userRecordLink(), a!safeLink(), a!submitLink(). If the links value is null or the array is empty, the label and instructions values render with no links listed. If a null value is entered as part of the links array, the component does not render and an error is displayed.
Alignment align Text Alignment of the link labels (except on mobile devices). Valid values are "LEFT", "CENTER", and "RIGHT". Appian recommends setting the alignment when used in the grid layout component only.

Example

Copy and paste an example to the Interface Designer to see it displayed.

=a!linkField(
  label: "Links",
  links: a!safeLink(
    label: "Company web site",
    uri: "http://www.appian.com"
  )
)

Displays the following:

17.1

On This Page

FEEDBACK