AX1011

Using symbols in Formatted Grids

You can use the Symbol content tag within a Grid data source to display symbols in the grid. The Symbol tag has no effect within the source file itself, but when the file is viewed as an Axiom form, the tag will be resolved as a symbol.

Content tag syntax for symbols

The syntax for the Symbol content tag is as follows:

[Symbol=SymbolName; Href=URL; UseNewWindow=True/False; Tooltip=Text; ColumnStyle=StyleName; Columns=Number;]

Parameters can be listed in any order. Optional parameters can be omitted.

To create the tag, you can manually type it within a cell, or you can use the Data Source Assistant / Tag Editor. For more information, see Creating and editing content tags in Formatted Grids.

Parameter Description

Symbol

The name of the symbol to display. The name must be a valid name from the symbol library.

For more information on how to browse symbols and find specific symbol names, see the following section.

Alternatively, you can use a bracketed cell reference to read the symbol name from the referenced cell. This approach is useful if you want to dynamically determine the symbol, 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.

If you use a cell reference, and the referenced cell currently contains a valid symbol name, then that symbol will be shown in the dialog.

HREF

Optional. The URL to a target file or web page. This can be used to display symbols that open a file or a web page when clicked.

For more information on how to generate a URL to a file within the Axiom database, see the discussion in Using hyperlinks in Formatted Grids.

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.

Tooltip

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.

UseNewWindow

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.

Columns

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.

ColumnStyle

Optional. Specifies one or more column styles to apply to the current cell. The specified styles override the current column styles set by the [ColumnStyle] tag, but only for the current cell contents (including the column span, if defined). The next cell down will not inherit the styles specified for this cell; the next cell will revert to using the currently applied column styles.

Enter one or more valid column style names, separated by commas. If you are using the Data Source Assistant / Tag Editor, you can click the [...] button to open the Choose Styles dialog and select from available styles. The available styles depend on the skin specified for the form. For more information, see Using row and column styles with Formatted Grids.

Alternatively, you can use a bracketed cell reference to read the style from the referenced cell. This approach is useful if you want to dynamically determine the style, 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.

Browsing available symbols

When using the Data Source Assistant / Tag Editor, you can browse the available symbols and have Axiom Software automatically create the tag for you with the appropriate symbol name.

For the Symbol parameter, click the Browse button [...] to open the Choose Symbol dialog. Within this dialog, you can scroll through the available symbols, or you can use the filter box at the top to find symbols based on symbol names. For example, you can type file to see all of the symbols that have the word "file" in the name, or you can type fa-file-o to find the symbol with that specific name. To find out the name for a particular symbol, hover your cursor over the symbol to see the symbol name in a tooltip.

When you have found the symbol that you want to use, select it and then click OK to add it to the Symbol tag.

NOTE: If you are using a cell reference for the Symbol field, then you should note the desired symbol name and then click Cancel to exit the dialog. If you click OK, the selected symbol name will overwrite the cell reference. After finding the symbol name, you can then go to the referenced cell and manually place the symbol name into that cell.

Tag examples

[Symbol=fa-filter]

This example displays the filter icon within the grid, when the file is viewed as an Axiom form.

[Symbol=fa-exclamation;ColumnStyle=[N];]

This example reads the column style from column N, in the row that contains the tag. The cell in column N could contain a formula that changes the style based on some criteria (for example, to show the symbol in red if the value is exceeds a certain threshold).

="[Symbol=fa-bar-chart;Href="&GetFormDocumentURL(G23)&";UseNewWindow=True]"

In this example the HREF parameter is used so that the user can double-click the bar chart icon to open the specified Axiom form.