HYPERLINK
Creates a shortcut that jumps to another location in the current workbook, or opens a document stored on your hard drive, a network server, or on the Internet.
Syntax
expression.HYPERLINK(arg1, arg2);
expression - A variable that represents a ApiWorksheetFunction class.
Parameters
| Name | Required/Optional | Data type | Default | Description |
|---|---|---|---|---|
| arg1 | Required | string | ApiRange | ApiName | The text giving the path and file name to the document to be opened, a hard drive location, UNC address, or URL path. | |
| arg2 | Optional | string | ApiRange | number | ApiName | Text or a number that is displayed in the cell. If omitted, the cell displays the link location text. |
Returns
string
Example
- Code
- Result
let worksheet = Api.GetActiveSheet();
let func = Api.GetWorksheetFunction();
worksheet.GetRange("A1").SetValue(func.HYPERLINK("https://example.com/files/example.xlsx", "Click here"));