SetTipText

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

继承自 ApiFormBase.SetTipText。

语法

expression.SetTipText(sText);

expression - 表示 ApiCheckBoxForm 类的变量。

参数

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

返回值

boolean

示例

在文档中为复选框表单添加工具提示文本。

// How do I display a helpful hint when a user hovers over a form field in a document?

// Guide respondents by attaching an instructional tooltip to each checkbox in a document.

let doc = Api.GetDocument();
let checkBoxForm = Api.CreateCheckBoxForm({"key": "Marital status", "tip": "Specify your marital status", "required": true, "placeholder": "Marital status", "radio": true});
let paragraph = doc.GetElement(0);
paragraph.AddElement(checkBoxForm);
paragraph.AddText(" Married");
paragraph.AddLineBreak();
checkBoxForm = Api.CreateCheckBoxForm({"key": "Marital status", "tip": "Specify your marital status", "required": true, "placeholder": "Marital status", "radio": true});
paragraph.AddElement(checkBoxForm);
paragraph.AddText(" Single");
checkBoxForm.SetTipText("Specify your marital status");
let tipText = checkBoxForm.GetTipText();
paragraph = Api.CreateParagraph();
paragraph.AddText("Tip text: " + tipText);
doc.Push(paragraph);