SetLink

Sets the hyperlink address.

Syntax

expression.SetLink(sLink);

expression - A variable that represents a ApiHyperlink class.

Parameters

Name	Required/Optional	Data type	Default	Description
sLink	Required	string		The hyperlink address.

Returns

boolean

Example

This example shows how to set a new URL for a hyperlink inside a shape.

• Code
• Result

const worksheet = Api.GetActiveSheet();

const fill = Api.CreateSolidFill(Api.RGB(160, 100, 130));
const stroke = Api.CreateStroke(0, Api.CreateNoFill());
const shape = worksheet.AddShape(
	'roundRect',
	Api.MillimetersToEmus(70), Api.MillimetersToEmus(20),
	fill, stroke,
	0, 0, 2, 0
);

const content = shape.GetContent();
const paragraph = content.GetElement(0);
const run = Api.CreateRun();
run.AddText('Visit ONLYOFFICE for developers');
paragraph.AddElement(run, 0);

const hyperlink = run.AddHyperlink('https://api.onlyoffice.com', 'ONLYOFFICE for developers');

hyperlink.SetLink('https://helpcenter.onlyoffice.com');
worksheet.GetRange('A1').SetValue('New link: ' + hyperlink.GetLinkedText());