SetToggleToOff
Sets whether the checked state can be toggled off.
Syntax
expression.SetToggleToOff(allowToggleOff);
expression - A variable that represents a ApiCheckboxField class.
Parameters
| Name | Required/Optional | Data type | Default | Description |
|---|---|---|---|---|
| allowToggleOff | Required | boolean | Specifies whether the checked state can be toggled off. |
Returns
boolean
Example
Enable or disable toggle-off behavior for a checkbox in a PDF.
// How do I make a checkbox uncheck when clicked if already checked in a PDF?
// Control whether a checked checkbox deselects on a second click in a PDF.
let doc = Api.GetDocument();
let page = doc.GetPage(0);
let checkboxField = Api.CreateCheckboxField([10, 10, 25, 25]);
page.AddObject(checkboxField);
checkboxField.SetToggleToOff(false);