跳到主要内容

SetTooltip

设置字段工具提示

备注

此功能仅在 ONLYOFFICE Docs 付费版本中可用。

继承自 ApiBaseField.SetTooltip。

语法​

expression.SetTooltip(tooltip);

expression - 表示 ApiCheckboxField 类的变量。

参数​

名称必需/可选数据类型默认值描述
tooltip必需string | null | undefined字段的工具提示文本。

返回值​

boolean

示例​

在 PDF 中为表单字段设置工具提示。

// Useful for adding helper text to a field.

// Assign a tooltip to a text field.

let doc = Api.GetDocument();
let page = doc.GetPage(0);
let textField = Api.CreateTextField([10, 10, 160, 30]);
page.AddObject(textField);

textField.SetTooltip("Enter your full name");