跳到主要内容

GetTipText

返回当前表单的提示文本。

继承自 ApiFormBase.GetTipText。

语法​

expression.GetTipText();

expression - 表示 ApiTextForm 类的变量。

参数​

此方法没有任何参数。

返回值​

string

示例​

获取文档中表单字段上设置的工具提示文本。

// How do I read the hint message shown to users when they hover over a field in a document?

// Display the guidance message attached to a text field in a document.

let doc = Api.GetDocument();
let textForm = Api.CreateTextForm({"key": "Personal information", "tip": "Enter your first name", "required": true, "placeholder": "First name", "comb": true, "maxCharacters": 10, "cellWidth": 3, "multiLine": false, "autoFit": false});
let paragraph = doc.GetElement(0);
paragraph.AddElement(textForm);
let tipText = textForm.GetTipText();
paragraph = Api.CreateParagraph();
paragraph.AddText("Form tip text: " + tipText);
doc.Push(paragraph);