SetHyperlink

Adds a hyperlink to the specified range.

Syntax

expression.SetHyperlink(sRange, sAddress, subAddress, sScreenTip, sTextToDisplay);

expression - A variable that represents a ApiWorksheet class.

Parameters

Name	Required/Optional	Data type	Default	Description
sRange	Required	string		The range where the hyperlink will be added to.
sAddress	Required	string		The link address.
subAddress	Optional	string		The link subaddress to insert internal sheet hyperlinks.
sScreenTip	Optional	string		The screen tip text.
sTextToDisplay	Optional	string		The link text that will be displayed on the sheet.

Returns

This method doesn't return any data.

Example

This example adds a hyperlink to the specified range.

• Code
• Result

// How to add hyperlinks to the range.

// Add a hyperlink to the cell.

let worksheet = Api.GetActiveSheet();
worksheet.SetHyperlink("A1", "https://api.onlyoffice.com/docbuilder/basic", "Api ONLYOFFICE", "ONLYOFFICE for developers");