AddHyperlink

Adds a hyperlink to the current text range.

Syntax

expression.AddHyperlink(link, screenTipText);

expression - A variable that represents an ApiTextRange class.

Parameters

Name	Required/Optional	Data type	Default	Description
link	Required	string		The link address. Accepts an external URL (http, https, mailto, ftp) or an internal link. In the presentation editor, the internal link is one of the slide actions: "ppaction://hlinkshowjump?jump=firstslide", "ppaction://hlinkshowjump?jump=lastslide", "ppaction://hlinkshowjump?jump=nextslide", "ppaction://hlinkshowjump?jump=previousslide", "ppaction://hlinksldjumpslide{N}" (N is the zero-based slide index), "ppaction://hlinkfile?file={path}" (opens an external file). In the spreadsheet editor, the internal link is "#" followed by a cell range or a defined name, for example, "#Sheet1!A1" or "#MyName".
screenTipText	Required	string		The screen tip text.

Returns

ApiHyperlink | null | undefined

Example

Turn a fragment of text into a hyperlink in a shape on a PDF page.

// The range must stay within a single paragraph, otherwise no hyperlink is added.

// Turn the word "here" into a link to the ONLYOFFICE website.

const doc = Api.GetDocument();
const page = doc.GetPage(0);

const fill = Api.CreateSolidFill(Api.RGB(255, 111, 61));
const stroke = Api.CreateStroke(0, Api.CreateNoFill());
const shape = Api.CreateShape("rect", 200 * 36000, 80 * 36000, fill, stroke);
shape.SetPosition(608400, 1267200);
page.AddObject(shape);

const docContent = shape.GetContent();
const paragraph = docContent.GetElement(0);
paragraph.AddText("Click here to learn more");

const range = shape.GetTextRange();

const link = range.GetRange(6, 10);
link.AddHyperlink("https://www.onlyoffice.com", "ONLYOFFICE");