Function

a!documentDownloadLink( label, document, showWhen )

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
• Buttons and links design guidance

Parameters

Usage considerations

Using document links with the link field component

To display a single link or an array of links, use this component inside the Link component.

You can display the document download link in the following places:

• To display a link in a grid, use inside a Read-Only Grid Column component.
• To add a link in a chart, use inside the Chart Series component.
• To add a link to an image, use inside a document image or web image component.

Examples

Copy and paste an example into an interface object in EXPRESSION MODE to see it displayed.

Downloading files using a constant

To test this example, replace cons!myDocument with a constant that points to a document in your environment.

Note that this uses the document() function to access the name of the document to display in the interface.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
  a!linkField(
    label: "Download document",
    labelPosition: "ABOVE",
    links: {
      a!documentDownloadLink(
        label: document(
          documentId: cons!myDocument,
          property: "name"
        ),
        document: cons!myDocument
      )
    }
  )
}

Feature compatibility

Related Patterns

The following patterns include usage of the Document Download Link.

• Comments Patterns (Comments, Looping): Use this pattern when displaying a chronological list of messages from different users, such as comments on a topic or notes on a case.

• Display Multiple Files in a Grid (Document Management, Grids): Show a dynamic number of files in a grid and edit certain file attributes.