SetRole

Sets the role to the current form.

Syntax

expression.SetRole(role);

expression - A variable that represents a ApiFormBase class.

Parameters

Name	Required/Optional	Data type	Default	Description
role	Required	string		The role which will be attached to the current form.

Returns

boolean

Example

This example shows how to set a role for a form element.

• Code
• Result

const doc = Api.GetDocument();
let paragraph = doc.GetElement(0);

const roles = doc.GetFormRoles();
const rolePr = { "color": "#ffefbf" };
roles.Add("MY_ROLE", rolePr);

const textForm = Api.CreateTextForm({
	"tip": "Enter your first name",
	"required": true,
	"placeholder": "First name",
	"comb": true,
	"maxCharacters": 10,
	"cellWidth": 3,
	"multiLine": false,
	"autoFit": false
});
paragraph.AddElement(textForm);

textForm.SetRole("MY_ROLE");
const role = textForm.GetRole();

paragraph = Api.CreateParagraph();
paragraph.AddText("Form role: " + role);
doc.Push(paragraph);