Skip to main content

SetMouseExit

Sets the MouseExit action.

Syntax​

expression.SetMouseExit(action);

expression - A variable that represents an ApiActionCollection class.

Parameters​

NameRequired/OptionalData typeDefaultDescription
actionRequiredApiBaseAction | null | undefinedThe action to set, or null to remove it.

Returns​

boolean

Example​

This example sets a JavaScript action to fire on MouseExit of a button widget.

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

let jsAction = Api.CreateJsAction("app.alert('Mouse exit!');");
let widgets = buttonField.GetAllWidgets();
let result = widgets[0].GetActions().SetMouseExit(jsAction);

console.log('MouseExit set: ' + result);