Skip to main content

MoveUp

Moves a role up in filling order.

Syntax

expression.MoveUp(name);

expression - A variable that represents a ApiFormRoles class.

Parameters

NameRequired/OptionalData typeDefaultDescription
nameRequiredstringThe role name.

Returns

boolean

Example

This example shows how to move up the specified role.

let doc = editor.GetDocument();
let roles = doc.GetFormRoles();
roles.Add("Customer");
roles.Add("Seller");

// Make the selected role the first one to fill
while (roles.MoveUp("Customer"));

let paragraph = doc.GetElement(0);
let orderIndex = 1;
roles.GetAllRoles().forEach(role => {
paragraph.AddText(orderIndex + ": ");
paragraph.AddText(role);
paragraph.AddLineBreak();
orderIndex++;
});