Skip to main content

HaveRole

Checks if a role with the specified name exists.

Syntax

expression.HaveRole(name);

expression - A variable that represents a ApiFormRoles class.

Parameters

NameRequired/OptionalData typeDefaultDescription
nameRequiredstringThe role name.

Returns

boolean

Example

This example shows how to add new roles.

let doc = editor.GetDocument();
let roles = doc.GetFormRoles();
roles.Add("Customer");
roles.Add("Seller");
let paragraph = doc.GetElement(0);
["Customer", "CEO"].forEach(roleName => {
if (roles.HaveRole(roleName)) {
paragraph.AddText(roleName + " role is present in the form");
} else {
paragraph.AddText(roleName + " role is not present in the form");
}
paragraph.AddLineBreak();
});