SetHyperlink

function SetHyperlink(
  sRange: string = null,
  sAddress: string = null,
  subAddress: string = null,
  sScreenTip: string = null,
  sTextToDisplay: string = null,
): void

Description

Adds a hyperlink to the specified range.

Parameters

sRangestringdefault: null

The range where the hyperlink will be added to.

sAddressstringdefault: null

The link address.

subAddressstringdefault: null

The link subaddress to insert internal sheet hyperlinks.

sScreenTipstringdefault: null

The screen tip text.

sTextToDisplaystringdefault: null

The link text that will be displayed on the sheet.

Returns

void

Try It

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

Get Help

  • If you have any questions about ONLYOFFICE Docs, try the FAQ section first.
  • You can request a feature or report a bug by posting an issue on GitHub.
  • You can also ask our developers on ONLYOFFICE forum (registration required).