AX1005
Using hyperlinks in Formatted Grids
You can use the HREF content tag within a Grid data source to present hyperlinks to other files or web pages. The HREF syntax has no effect within the source file itself, but when the file is viewed as an Axiom form, the HREF tag will be resolved as a clickable hyperlink.
NOTE: Other means of creating clickable hypertext within a spreadsheet—such as using Excel's Hyperlink function, or Axiom Financial Institutions Suite's GetDocument function—will not work when the file is viewed as an Axiom form. The text will not render as clickable, and the target file or URL will not open.
Example HREF tags in a Grid data source
Rendering of example tags in an Axiom form
Content tag syntax for hyperlinks
The syntax for the HREF content tag is as follows:
[Href=URL; Text=DisplayText; UseNewWindow=True/False; Tooltip=Text; ColumnStyle=StyleName; Columns=Number;]
Parameters can be listed in any order. Optional parameters can be omitted.
(missing or bad snippet)Parameter | Description |
---|---|
HREF | The URL to the target file or web page. See the following section for more information on how to generate a URL to a file within the Axiom database. When using the Data Source Assistant / Tag Editor, you can use the [...] button to select a file in the Axiom file system. If you browse to a file rather than specifying a URL, then the HREF parameter will contain a document reference instead of a URL. This document reference will be dynamically converted to a URL when the form is rendered. Alternatively, you can use a bracketed cell reference to read the URL from the referenced cell. This approach is useful if you want to dynamically determine the URL, because then the formula can be in the referenced cell instead needing to construct the tag using a formula. For more information, see Referencing cells in content tag parameters. |
Text | Optional. The display text for the hyperlink. If omitted, the URL will be the display text. You can define the text within the tag directly, or you can use a bracketed cell reference to read the placeholder text from another cell. This approach is useful if you want to dynamically determine the text, because then the formula can be in the referenced cell instead needing to construct the tag using a formula. For more information, see Referencing cells in content tag parameters. NOTE: If desired, you can use a symbol instead of display text for the hyperlink. In this case, the user can double-click the symbol to open the specified URL. To do this, replace the Text parameter with a Symbol parameter. For more information on symbol syntax, see Using symbols in Formatted Grids. |
Tooltip | (missing or bad snippet) |
UseNewWindow | (missing or bad snippet) |
Columns | (missing or bad snippet) |
ColumnStyle | (missing or bad snippet) |
For example:
[Href=http://www.axiomepm.com;Text=Axiom Financial Institutions Suite;UseNewWindow=True]
This example creates a hyperlink to the Axiom Financial Institutions Suite website using the display text "Axiom Financial Institutions Suite". The hyperlink will open in a new window.
NOTE: Alternatively, you can use the functions GetFormDocumentLinkTag and GetFormResourceLinkTag to generate the HREF tag for you, given parameters such as the document ID and the display text. These functions can only be used to generate HREF tags to form-enabled documents and to plan file attachments. These functions return basic HREF syntax that cannot be modified to include optional features (like using a symbol instead display text, or defining colors in the tag).
Hyperlink behavior notes
Hyperlinks generated by HREF tags are displayed in blue font with no underline by default. If desired, you can use the UNDERLINED style to apply an underline to the text. Styles can be applied on an individual tag basis by using the ColumnStyle parameter, or at the column level by using a [ColumnStyle]
row.
Generating a URL to a file in the Axiom file system
(missing or bad snippet)When using the Tag Editor to create the HREF tag, you can browse to any file within the Axiom file system. This places a document reference within the tag, which will be dynamically converted to a URL when the form is rendered. This approach may be useful to link to a specific, static file in the Axiom file system.
The following examples use a formula to generate the URL for the hyperlink:
="[Href="&GetFormResourceURL(G23)&";Text=Open Attachment"&H23&"]"
This example uses GetFormResourceURL to generate a URL to a plan file attachment, where the document ID or file path is located in cell G23. The display text incorporates the name of the attachment from cell H23. The UseNewWindow parameter is omitted because it is inapplicable to plan file attachments, which do not open in browser windows.
="[Href="&GetFormDocumentURL(G23)&";Text=Open Plan File for "&H23&";UseNewWindow=True]"
This example uses GetFormDocumentURL to generate a URL to a form-enabled plan file, where the document ID or file path is located in cell G23. The display text incorporates the name of the associated plan code from cell H23 (something like "Dept 42000"). The plan file form will open in a new window.