跳到主要内容

SetRole

为当前表单设置角色。

继承自 ApiFormBase.SetRole。

语法​

expression.SetRole(role);

expression - 表示 ApiSignatureForm 类的变量。

参数​

名称必需/可选数据类型默认值描述
role必需string将附加到当前表单的角色。

返回值​

boolean

示例​

在文档中为签名字段分配角色。

// How do I specify who is responsible for signing a particular signature field in a document?

// Label a signature field with a named role to indicate the intended signer in a document.

let doc = Api.GetDocument();
let roles = doc.GetFormRoles();
roles.Add("Signatory");
let signatureForm = Api.CreateSignatureForm({"key": "Signature", "tip": "Please sign here", "placeholder": "Signature"});
signatureForm.SetRole("Signatory");
let paragraph = doc.GetElement(0);
paragraph.AddElement(signatureForm);
let role = signatureForm.GetRole();
paragraph = Api.CreateParagraph();
paragraph.AddText("Form role: " + role);
doc.Push(paragraph);