Skip to main content

SetCheckedByDefault

Sets widget checked by default.

Syntax

expression.SetCheckedByDefault(bChecked);

expression - A variable that represents a ApiCheckboxWidget class.

Parameters

NameRequired/OptionalData typeDefaultDescription
bCheckedRequiredbooleanNo description provided.

Returns

boolean

Example

This example sets checkbox widget checked by default property.

let doc = Api.GetDocument();
let page = doc.GetPage(0);
let radiobuttonField = Api.CreateRadiobuttonField([10, 10, 25, 25]);
page.AddObject(radiobuttonField);

let widgets = radiobuttonField.GetAllWidgets();
widgets[0].SetCheckedByDefault(true);
console.log('Checked by default is: ' + widgets[0].IsCheckedByDefault());