Skip to main content

SetBorderColor

Sets widget border color.

Syntax

expression.SetBorderColor(color);

expression - A variable that represents a ApiBaseWidget class.

Parameters

NameRequired/OptionalData typeDefaultDescription
colorRequiredApiColorThe border color.

Returns

boolean

Example

Apply a border color to all field widgets in a PDF.

// How do I set the border color for widgets in a PDF?

// Change the outline color of widget borders 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);
});