Skip to main content

SetLayout

Sets button widget layout type

Syntax

expression.SetLayout(sType);

expression - A variable that represents a ApiButtonWidget class.

Parameters

NameRequired/OptionalData typeDefaultDescription
sTypeRequiredButtonLayoutbutton layout type

Returns

boolean

Example

Set button widget layout type in a PDF document.

// How do I set layout in a PDF document?

// Set layout using a button widget object in a PDF document.

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].SetLabel('Layout is: ' + widgets[0].GetLayout());