Link Component

Function: a!linkField()

Display one or more links of any type. Link types serve two main purposes: to navigate to objects, such as tasks and records, or to perform actions, such as downloading documents or starting processes.

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.
  • "JUSTIFIED" Aligns the label alongside the component starting at the edge of the page.
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 If the value for links is null or the array is empty, the label and instructions values render with no links listed.
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.
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.

Example

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

1
2
3
4
5
6
7
=a!linkField(
  label: "Links",
  links: a!safeLink(
    label: "Company web site",
    uri: "http://www.appian.com"
  )
)

Displays the following:

FEEDBACK