Document Download Link

Function: a!documentDownloadLink()

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

See also: Link, Read-Only Grid, Images, Folder and Document Management

Parameters

Name Keyword Types Description

Label

label

Text

Text displayed as the link name the user clicks on.

Document

document

Document

The ID of the document that downloads when the user clicks the link.

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.

Notes

  • To display a single link or array of links, use inside the Link Field component. To display a link in a grid, use inside a GridTextColumn. To add a link to an image, use inside a document or web image. To add a link to a chart series, use inside the a!chartSeries() function.

The following patterns include usage of the Document Download Link.

Open in Github

On This Page

FEEDBACK