SetScreenTipText
Sets the screen tip text of the hyperlink.
Syntax
expression.SetScreenTipText(sScreenTipText);
expression - A variable that represents a ApiHyperlink class.
Parameters
| Name | Required/Optional | Data type | Default | Description |
|---|---|---|---|---|
| sScreenTipText | Required | string | The screen tip text of the hyperlink. |
Returns
boolean
Example
This example sets the screen tip text of the hyperlink.
- Code
- Result
const presentation = Api.GetPresentation();
const slide = presentation.GetSlideByIndex(0);
slide.RemoveAllObjects();
const fill = Api.CreateSolidFill(Api.HexColor('#C5D8A4'));
const stroke = Api.CreateStroke(0, Api.CreateNoFill());
const shape = Api.CreateShape('roundRect', Api.MillimetersToEmus(300), Api.MillimetersToEmus(130), fill, stroke);
shape.SetPosition(Api.MillimetersToEmus(20), Api.MillimetersToEmus(35));
const hyperlink = Api.CreateHyperlink('https://api.onlyoffice.com/', 'ONLYOFFICE website')
hyperlink.SetScreenTipText('Visit ONLYOFFICE');
shape.SetHyperlink(hyperlink);
const infoParagraph = Api.CreateParagraph();
infoParagraph.AddText('Shape hyperlink screen tip: ' + hyperlink.GetScreenTipText());
const docContent = shape.GetContent();
docContent.Push(infoParagraph);
slide.AddObject(shape);