Skip to main content

CreateGoToAction

Creates a GoTo action.

Syntax​

expression.CreateGoToAction(page, goToType, zoom, rect);

expression - A variable that represents an Api class.

Parameters​

NameRequired/OptionalData typeDefaultDescription
pageRequirednumberNo description provided.
goToTypeRequiredGoToTypeNo description provided.
zoomOptionalpercentage1zoom ratio, 1 is equal 100% (used only for goToType == "xyz")
rectRequiredRectNo description provided.

Returns​

ApiGoToAction

Example​

This example creates a GoTo action that navigates to the first 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 goToAction = Api.CreateGoToAction(0, "fit", null, [0, 0, 200, 300]);
let widgets = buttonField.GetAllWidgets();
widgets[0].GetActions().SetMouseUp(goToAction);

console.log('GoTo action class type: ' + goToAction.GetClassType());