Get Started
Documentation

GetScreenTipText

GetScreenTipText() → { string }

Gets the ScreenTip text of the hyperlink.

Returns:

Type
string

Example

Copy code
builder.CreateFile("docx");
oDocument = Api.GetDocument();
oParagraph = oDocument.GetElement(0);
oRun = Api.CreateRun();
oRun.AddText("ONLYOFFICE Document Builder");
oParagraph.AddElement(oRun);
oHyperlink = oParagraph.AddHyperlink("http://api.teamlab.info/docbuilder/basic");
oHyperlink.SetScreenTipText("ONLYOFFICE for developers");
oScreenTipText = oHyperlink.GetScreenTipText();
oParagraph = Api.CreateParagraph();
oParagraph.AddText("Screen tip text: " + oScreenTipText);
oDocument.Push(oParagraph);
builder.SaveFile("docx", "GetScreenTipText.docx");
builder.CloseFile();

Resulting document