Skip to main content

SetScaleWhen

Sets button widget scale when type

Syntax

expression.SetScaleWhen(sType);

expression - A variable that represents a ApiButtonWidget class.

Parameters

NameRequired/OptionalData typeDefaultDescription
sTypeRequiredButtonScaleWhenbutton widget scale when type

Returns

boolean

Example

This example sets button widget scale when type.

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

let widgets = buttonField.GetAllWidgets();
widgets[0].SetLayout('iconTextV');
widgets[0].SetScaleWhen('always');
widgets[0].SetLabel('Scale when is: ' + widgets[0].GetScaleWhen());