Skip to main content

CreateNamedAction

Creates a named action.

Syntax​

expression.CreateNamedAction(name);

expression - A variable that represents an Api class.

Parameters​

NameRequired/OptionalData typeDefaultDescription
nameRequiredNamedActionTypeNo description provided.

Returns​

ApiNamedAction

Example​

This example creates a named action that navigates to the next page and assigns it to a button widget.

let doc = Api.GetDocument();
let page = doc.GetPage(0);
let buttonField = Api.CreateButtonField([10, 10, 100, 30]);
page.AddObject(buttonField);

let namedAction = Api.CreateNamedAction("NextPage");
let widgets = buttonField.GetAllWidgets();
widgets[0].GetActions().SetMouseUp(namedAction);

console.log('Named action name: ' + namedAction.GetName());