Hyperlink

Text and image placed to a cell can act as a hyperlink. On clicking the cell contents the specified action is executed.

NOTE. A hyperlink is available only in the Reports tool and is set up for a whole cell, that is, it is not possible to separately set up hyperlinks for image and part of text.

To set up hyperlink parameters, go to the Hyperlink tab of the formatting dialog box:

TIP. By default, all report hyperlinks are blue and underlined. To set up a single hyperlink custom formatting, use the Settings tab in the Parameters dialog box.

Hyperlink Action

Opening a hyperlink does not result in any action.

When this action is selected, the File Name box appears where the file to be opened at hyperlink opening is specified. To open the dialog box, click the Browse button in this box. A standard file selection dialog box opens.

When this action is selected, the Hyperlink box is shown. Enter required hyperlink URL in the box, this URL is used to follow on clicking the hyperlink.

When this action is selected, the Report Sheets drop-down list opens, in which select the sheet, to which you will jump after clicking the link.

When this action is selected, the Range Description box is shown. Enter to it a cell range, which will be selected on clicking the hyperlink. Available range input options:

To describe a rectangular area, first specify the address of the upper left cell, from which the range starts, and then the address of the lower right cell, which ends the range, separating them with a colon.
If positioning to a single cell is required, specify only address of this cell.
To describe a combined area, use semicolon to specify the addresses of rectangular areas and separate cells, of which this area consists.

When this action is selected, the Report Objects drop-down list is shown. Choose an object in it, to which you go after clicking the hyperlink. Objects include charts, maps, images, and so on.

When this action is selected, the Repository Objects drop-down list opens. Choose a repository object in it, which opens after clicking the hyperlink.

When this action is selected, two additional boxes appear:

Unit. Select a development environment unit connected to the regular report.
Procedure/Function. Specify name of the procedure or function that must be started in the desktop application on hyperlink click.
JS-Function. Specify name of the JS-function that must be started in the web application on hyperlink click. This may be a system and a custom JS-function. Function name has to specified as follows:

Function name (custom parameters, args)

Parameters:

Custom parameters. Required parameters.

Args. Function arguments.

Function signature:

function <Function name>(custom parameters, args)

{

…

}

Function example:

function testHyperlink(type, args)

{

debugger;

console.log(type);

console.log(args);

}

NOTE. It is allowed to specify only procedure or function name or JS-function name. In this case the hyperlink opens only in the desktop or only in the web application.

When a hyperlink is used, reports or data entry forms may return the following parameters as arguments:

Report. Parameter for managing a report.
ReportOdId. Report identifier.
DataEntryForm. Parameter for managing a data entry form. It is available only for data entry forms.
DataArea. Parameter for managing a table area. It is available only for data entry forms.

The example of function when used in a data entry form:

function addAttachmentsTB(row, col, args)

{

var rep = args.Report;

var da = args.DataArea;

var grid = da.getGridView();

var tabSheet = grid.getTabSheet();

var tabSheetRange = tabSheet.getCell(row, col);

attachFile(da, tabSheetRange);

}

The unit connected to regular report enables the user to:

Process data input "on the go".
Output a dialog box for confirmation of executed action.
Execute additional actions before and/or after occurring of any event.
Output messages containing particular information (for example, identifier of changed control, hyperlink type and so on) and others.

Depending on where procedure or function implementation is located, the method to specify path to it differs. A procedure or function is implemented in:

Repository unit/form: <procedure/function name>.
One of repository assembly objects: <procedure/function name>.

NOTE. Procedure/function signature can contain parameters.

To learn how to create a hyperlink, see the Example of Creating a Hyperlink section.