contentControls.checkbox.getState

Get the checked state of a checkbox content control.

read-onlyidempotent
doc.contentControls.checkbox.getState(…)

Expected result

Returns a CheckboxGetStateResult with the checked boolean.

Inputs

targetobjectrequired
Fields
kind"block" | "inline"required
nodeType"sdt"required
nodeIdstringrequired

Result

Output fields
checkedbooleanrequired

Failures

Pre-apply throws

  • TARGET_NOT_FOUND
  • INVALID_INPUT
  • CAPABILITY_UNAVAILABLE
1 more codes
  • TYPE_MISMATCH

Raw schemas

Open the generated JSON artifact for the exact input, output, success, and failure schemas represented by this contract version.

View raw JSON schemas