Hyperlink component for Axiom forms

The display text for the hyperlink.

The URL to launch when the button is clicked. The URL must use full HTTP syntax—meaning, use HTTP://www.axiomepm.com, not www.axiomepm.com.

The URL can be to a web page, an Axiom form, or an Axiom file. See Generating a URL to a file in the Axiom file system for more details.

The standard HTML "mailto" syntax can also be used here, to open an email with the specified parameters. For example:

Optional. The tooltip text for the component. When a user hovers the cursor over the component, the text displays in a tooltip.

Specifies whether the link is opened in a new window. By default this is enabled, which means the link is opened in a new window. Disable this option if you want the link to open within the same window (replacing the current Axiom form).

NOTE: Disable this option if you have linked to an Axiom file (to be opened in the Excel Client or the Windows Client) but this Axiom form will be viewed in the Web Client. Otherwise, a new blank window will be opened in the browser in addition to opening the specified file.

The name of the component. This is for identification in the file; this name does not display on the Axiom form canvas.

The name of the component identifies the corresponding settings for the component on the Form Control Sheet. The component names are also useful if you have multiple types of the same component within an Axiom form, so that you can tell which component you are currently editing.

Component names must be unique within a file and must start with a letter. Names can only contain letters, numbers, and underscores. Names are validated when the file is saved; an invalid name will prevent the save.

NOTE: Spaces are not allowed in component names and will be automatically removed by Axiom Software. For example, if you enter "My Component" as the component name, it will be automatically adjusted to "MyComponent".

Specifies whether the component is visible on the Axiom form (On/Off). By default this is set to On.

This setting can be used to dynamically show or hide the component using a formula. Keep in mind that if you have multiple components that you need to dynamically show or hide based on the same condition, then it is preferable to place those components on a dedicated layer and then show or hide the entire layer instead of the individual components.

NOTE: This setting is only available on the Form Control Sheet; it cannot be set in the Form Assistant or in the Form Designer.

The layer that the component belongs to on the Axiom form canvas. In the Form Assistant and the Form Designer, this displays as the layer name (for example: Layer 1). In the Form Control Sheet, this is recorded as the layer ID (for example: 1).

If the canvas only has one layer, then the component is automatically assigned to that layer and cannot be changed. If the canvas has multiple layers, you can assign the component to any layer using the drop-down list. By default, the component will be assigned to whichever layer is selected in the Layers box when you initially drag the component onto the canvas. For more information on layers, see Using multiple layers on the canvas.

If desired, you can jump to the applicable layer settings on the Form Control Sheet by clicking the binoculars icon next to the drop-down list.

Optional. The styles used to determine the formatting of the component. You can assign one or more styles.

Click the Select component styles button [...] to open the Choose Style dialog. Using this dialog, you can select one or more styles to apply to the component. The available styles depend on the component type and the skin assigned to the form. For more information, see Using component styles.

Some components have several styles that are specifically designed for that component type, while other components may only have the "generic" styles that are available to all components. When using a generic style, keep in mind that they may not be useful for all components. You can view a description of each style and view the effective formatting applied by the selected styles within the Choose Style dialog.

The reference location determines how the x-position and y-position of a component are evaluated. By default the reference location is UpperLeft.

NOTE: This setting is not exposed in the advanced component settings. It can be changed on the canvas by double-clicking the corner selection handles of a component, or you can edit the setting on the Form Control Sheet directly.

The x-position determines the component's position along the horizontal axis, and the y-position determines the component's position along the vertical axis. Both are evaluated relative to the reference location. Positions can be set in pixels (default) or percentages.

The order in which the component is rendered in the layer. A component with a larger order number will display above a component with a smaller order number.

For components that support tab navigation (tabbing to the next editable component), the rendering order also determines the tabbing order.

NOTE: On the Form Control Sheet, this setting is labeled as Z-Index.

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.