跳到主要内容

SetTipText

设置当前表单的提示文本。

继承自 ApiFormBase.SetTipText。

语法​

expression.SetTipText(sText);

expression - 表示 ApiPictureForm 类的变量。

参数​

名称必需/可选数据类型默认值描述
sText必需string提示文本。

返回值​

boolean

示例​

在文档中添加用户将鼠标悬停在图片字段上时显示的工具提示。

// How do I provide a helpful hint that shows up when someone points at a picture field in a document?

// Guide users by attaching a short instructional message to a picture field in a document.

let doc = Api.GetDocument();
let pictureForm = Api.CreatePictureForm({"key": "Personal information", "required": true, "placeholder": "Photo", "scaleFlag": "tooBig", "lockAspectRatio": true, "respectBorders": false, "shiftX": 50, "shiftY": 50});
pictureForm.SetImage("https://static.onlyoffice.com/assets/docs/samples/img/onlyoffice_logo.png", Api.MillimetersToEmus(70), Api.MillimetersToEmus(80));
let paragraph = doc.GetElement(0);
paragraph.AddElement(pictureForm);
pictureForm.SetTipText("Upload your photo");
let tipText = pictureForm.GetTipText();
paragraph = Api.CreateParagraph();
paragraph.AddText("Tip text: " + tipText);
doc.Push(paragraph);