Skip to main content

SetScreenTipText

Sets the screen tip text of the hyperlink.

Syntax​

expression.SetScreenTipText(sScreenTipText);

expression - A variable that represents a ApiHyperlink class.

Parameters​

NameRequired/OptionalData typeDefaultDescription
sScreenTipTextRequiredstringThe screen tip text of the hyperlink.

Returns​

boolean

Example​

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

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', 'NO SCREEN TIP');

hyperlink.SetScreenTipText('ONLYOFFICE for developers');
worksheet.GetRange('A1').SetValue('Screen tip: ' + hyperlink.GetScreenTipText());