Skip to main content
Alpha: Document API is currently alpha and subject to breaking changes.

​
Summary

Get the checked state of a checkbox content control.
  • Operation ID: contentControls.checkbox.getState
  • API member path: editor.doc.contentControls.checkbox.getState(...)
  • Mutates document: no
  • Idempotency: idempotent
  • Supports tracked mode: no
  • Supports dry run: no
  • Deterministic target resolution: yes

​
Expected result

Returns a CheckboxGetStateResult with the checked boolean.

​
Input fields

FieldTypeRequiredDescription
targetobject(nodeType=“sdt”)yes
target.kindenumyes"block", "inline"
target.nodeIdstringyes
target.nodeType"sdt"yesConstant: "sdt"

​
Example request

{
  "target": {
    "kind": "block",
    "nodeId": "node-def456",
    "nodeType": "sdt"
  }
}

​
Output fields

FieldTypeRequiredDescription
checkedbooleanyes

​
Example response

{
  "checked": true
}

​
Pre-apply throws

  • TARGET_NOT_FOUND
  • INVALID_INPUT
  • CAPABILITY_UNAVAILABLE
  • TYPE_MISMATCH

​
Non-applied failure codes

  • None

​
Raw schemas

{
  "additionalProperties": false,
  "properties": {
    "target": {
      "additionalProperties": false,
      "properties": {
        "kind": {
          "enum": [
            "block",
            "inline"
          ]
        },
        "nodeId": {
          "type": "string"
        },
        "nodeType": {
          "const": "sdt"
        }
      },
      "required": [
        "kind",
        "nodeType",
        "nodeId"
      ],
      "type": "object"
    }
  },
  "required": [
    "target"
  ],
  "type": "object"
}

{
  "additionalProperties": false,
  "properties": {
    "checked": {
      "type": "boolean"
    }
  },
  "required": [
    "checked"
  ],
  "type": "object"
}