Skip to main content

GetBackgroundColor

Gets widget background color.

Syntax​

expression.GetBackgroundColor();

expression - A variable that represents a ApiBaseWidget class.

Parameters​

This method doesn't have any parameters.

Returns​

ApiColor

Example​

This example gets field widget and displays it's background color.

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

textField.AddWidget(0, [10, 40, 160, 60]);
let widgets = textField.GetAllWidgets();
let rgbColor = Api.RGB(255, 100, 0);
widgets.forEach(function(widget) {
    widget.SetBackgroundColor(rgbColor);
});
let bgColor = widgets[0].GetBackgroundColor();
textField.SetValue('Widgets background color is: ' + bgColor.R + ',' + bgColor.G + ',' + bgColor.B);