View this page in the latest version of Appian. Document Download Link Share Share via LinkedIn Reddit Email Copy Link Print On This Page 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 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. 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 The table below lists this component's compatibility with various features in Appian. Feature Compatibility Note Portals Compatible Offline Mobile Compatible Sync-Time Custom Record Fields Incompatible Real-Time Custom Record Fields Incompatible Custom record fields that evaluate in real time must be configured using one or more Custom Field functions. Process Reports Incompatible Cannot be used to configure a process report. Process Events Incompatible Cannot be used to configure a process event node, such as a start event or timer event. 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. Feedback Was this page helpful? SHARE FEEDBACK Loading...