跳到主要内容

GetScreenTipText

Returns the screen tip text of the hyperlink.

Syntax​

expression.GetScreenTipText();

expression - A variable that represents a ApiHyperlink class.

Parameters​

This method doesn't have any parameters.

Returns​

string

Example​

This example shows how to get the screen tip text of the hyperlink.

// How to show the screen tip text of the hyperlink.

// Set and display the hyperlink tip text appearing on the screen.

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

const fill = Api.CreateSolidFill(Api.HexColor('#456789'));
const stroke = Api.CreateStroke(0, Api.CreateNoFill());
const shape = Api.CreateShape('rect', 150 * 36000, 150 * 36000, fill, stroke);
page.AddObject(shape);

const docContent = shape.GetContent();
let paragraph = docContent.GetElement(0);

let run = Api.CreateRun();
run.AddText("ONLYOFFICE Document Builder");
paragraph.AddElement(run);
let hyperlink = paragraph.AddHyperlink("https://api.onlyoffice.com/docbuilder/basic");
hyperlink.SetScreenTipText("ONLYOFFICE for developers");
let screenTipText = hyperlink.GetScreenTipText();
paragraph = Api.CreateParagraph();
paragraph.AddText("Screen tip text: " + screenTipText);
docContent.Push(paragraph);