Skip to main content

IsCheckBoxChecked

Determines whether a checkbox content control is currently checked or unchecked.

Throws: Error if the content control is not a checkbox.

Syntax​

expression.IsCheckBoxChecked();

expression - A variable that represents an ApiInlineLvlSdt class.

Parameters​

This method doesn't have any parameters.

Returns​

boolean

Example​

Read the checked state of a checkbox content control in a document.

// How do I find out whether a checkbox content control is checked in a document?

// Conditionally display text based on whether a checkbox is ticked or unticked in a document.

let doc = Api.GetDocument();
let checkBox = doc.AddCheckBoxContentControl();
let paragraph = Api.CreateParagraph();
doc.Push(paragraph);
let isChecked = checkBox.IsCheckBoxChecked();
paragraph.AddText("Checked: " + (isChecked ? "true" : "false"));