AX1007

GetFormResourceURL function

Generates a URL to a non-Axiom file within the Axiom file system, to open the file in its native application. If this URL is used in content tags within a Formatted Grid component, it will result in a clickable hyperlink to open the file from an Axiom form.

This function is specifically intended for situations where you are using an Axiom query to bring in a list of plan file attachments, and you want to generate hyperlinks to those files so that the user can open them from the Axiom form. You would then display the hyperlinks in the form using a Formatted Grid component.

Syntax

GetFormResourceURL(DocIDorPath)

Parameter Description

DocIDorPath

The file for which you want to return a URL. You can specify this file by entering either of the following:

  • The document ID of the file, such as 93.
  • The full path to the file, such as \Axiom\File Groups\Budget 2020\Plan File Attachments\24000\Proposal.pdf.

All non-numeric entries must be placed in double quotation marks, unless you are using cell references to reference the text held in another cell. However, the Boolean values TRUE and FALSE do not need to be in quotation marks.

Remarks

  • Both GetFormResourceLinkTag and GetFormResourceURL can be used to generate a hyperlink to a plan file attachment within a Formatted Grid component. GetFormResourceLinkTag generates a complete but basic set of Href content tags that cannot be further modified. GetFormResourceURL generates a URL that can be used within a set of Href content tags that you create manually, thereby allowing more flexibility in how the content tags are set up.

  • If your system is deployed in an environment where users work in different system languages, then you should use system folder names in any file paths. For more information, see Using system folder names.

  • GetFormResourceURL is a non-volatile function.

Examples

=GetFormResourceURL(930)

This example generates a URL to a non-Axiom file within the Axiom file system. However, the function would rarely be used on its own; instead it would be part of content tags used within a Formatted Grid component. For example:

="[Href="&GetFormResourceURL(G23)&";Text=Open attachment]"

In this case, the GetFormResourceURL function is used within a formula to create a full string of content tags. The function is looking up the document ID from cell G23.

The content tags do not have any effect within the spreadsheet itself. In order to generate a hyperlink, the content tags would be used within a cell that is part of a data source for a Formatted Grid component. When the source file is viewed as an Axiom form, the tags would be rendered as a clickable hyperlink within the grid.

See also