SetScreenTipText

设置超链接的屏幕提示文本。

语法

expression.SetScreenTipText(sScreenTipText);

expression - 表示 ApiHyperlink 类的变量。

参数

名称	必需/可选	数据类型	默认值	描述
sScreenTipText	必需	string		超链接的屏幕提示文本。

返回值

boolean

示例

设置鼠标悬停在文档中超链接上时显示的工具提示文本。

// How do I add a screen tip to a hyperlink in a document?

// Provide a descriptive hover message for a link to guide readers in a document.

let doc = Api.GetDocument();
let paragraph = doc.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);
doc.Push(paragraph);