Using hyperlinks in Formatted Grids

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.

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.

Optional. Specifies tooltip text to display when a user hovers the cursor over the cell contents.

Alternatively, you can use a bracketed cell reference to read the tooltip text from the referenced 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.

Optional. Specifies whether the URL target will open in a new browser window (True/False). If omitted, the default is False, meaning the target will open in the same browser window (replacing the current window contents). File tabs opened within the Desktop ClientGeneral term for using either the Excel Client or the Windows Client, both of which are installed to the user's desktop. are treated the same as browser windows for this purpose.

This parameter does not apply and should not be specified for URL targets that do not open in a browser window, such as when linking to spreadsheet Axiom files or plan file attachments. In this case, the parameter should always be omitted or set to False.

Optional. Specifies how many columns the cell contents will span in the grid.

If this parameter is omitted or set to 1, then content generated by the tag will only span the current column. If you want the content to span multiple columns, enter a number such as 2 to span 2 columns. The column span extends to the right.

NOTE: The row and column styles used in the grid impact how the column span displays. For example, if the content in the starting column is left-aligned and does not naturally exceed the width of the starting column, then the spanned columns will simply be blank because no content is extending to those columns. However, if the content is long enough to extend out of the starting column, or if the content has external borders (such as a text box), or if the content is center-aligned or right-aligned, then content will display in the spanned columns.

Use GetFormDocumentURL to generate a URL to another Axiom form, given a file path or a document ID.

Various methods are available to return the file path or the document ID of a particular file, and/or to generate a list of files and IDs.

• You can use an Axiom query to the Axiom.FileSystemInfo system table to generate a list of form-enabled files of any type (reports, plan files, etc.). The query can include the full path or the document ID, either of which can be used to generate the URL.

• You can use the function GetPlanFilePath to look up the file path of a particular plan file, given the plan code (for example, department 3000) and the file group name. GetPlanFilePath should be preferred over GetPlanFileDocumentID, for performance reasons.

• You can look up the document ID or file path of an individual file within Axiom Explorer and place it within the function. Generally this would only be useful to create a link to a static file that all viewers of the form need access to, such as to a form-enabled report.

When using GetFormDocumentURL, you can optionally apply a sheet filter to the target form, and/or optionally pass variable values to the target form.

Use GetWebReportDocumentURL to generate a URL to a web report, given a file path or a document ID.

You can look up the ID or file path of any individual file in Axiom Explorer, or you can query the Axiom.FileSystemInfo table to get a list of files, paths, and IDs.

Use GetFormResourceURL to generate a URL to a plan file attachment, given a file path or a document ID.

The document IDs for plan file attachments can be returned by querying the Axiom.PlanFileAttachments table. File paths can be returned by querying the Axiom.FileSystemInfo table.