Skip to main content

GetAllWidgets

Gets array with widgets of the current field.

Inherited from ApiBaseField.GetAllWidgets.

Example​

Access all visual instances of a form field in a PDF.

// How can I retrieve every visual representation of a form field in a PDF?

// Modify the appearance of all form field widgets in a PDF.

let doc = Api.GetDocument();
let page = doc.GetPage(0);
let textField = Api.CreateTextField([10, 10, 160, 30]);
page.AddObject(textField);

textField.SetValue('Example text');
textField.AddWidget(0, [10, 40, 160, 60]);
let widgets = textField.GetAllWidgets();
let rgbColor = Api.RGB(255, 100, 0);
widgets.forEach(function(widget) {
    widget.SetBorderColor(rgbColor);
});