| Operation | Member path | Mutates | Idempotency | Tracked | Dry run |
|---|---|---|---|---|---|
create.contentControl | create.contentControl | Yes | non-idempotent | No | Yes |
contentControls.list | contentControls.list | No | idempotent | No | No |
contentControls.get | contentControls.get | No | idempotent | No | No |
contentControls.listInRange | contentControls.listInRange | No | idempotent | No | No |
contentControls.selectByTag | contentControls.selectByTag | No | idempotent | No | No |
contentControls.selectByTitle | contentControls.selectByTitle | No | idempotent | No | No |
contentControls.listChildren | contentControls.listChildren | No | idempotent | No | No |
contentControls.getParent | contentControls.getParent | No | idempotent | No | No |
contentControls.wrap | contentControls.wrap | Yes | conditional | No | Yes |
contentControls.unwrap | contentControls.unwrap | Yes | conditional | No | Yes |
contentControls.delete | contentControls.delete | Yes | conditional | No | Yes |
contentControls.copy | contentControls.copy | Yes | non-idempotent | No | Yes |
contentControls.move | contentControls.move | Yes | conditional | Yes | Yes |
contentControls.patch | contentControls.patch | Yes | conditional | No | Yes |
contentControls.setLockMode | contentControls.setLockMode | Yes | conditional | No | Yes |
contentControls.setType | contentControls.setType | Yes | conditional | No | Yes |
contentControls.getContent | contentControls.getContent | No | idempotent | No | No |
contentControls.replaceContent | contentControls.replaceContent | Yes | conditional | No | Yes |
contentControls.clearContent | contentControls.clearContent | Yes | conditional | No | Yes |
contentControls.appendContent | contentControls.appendContent | Yes | conditional | No | Yes |
contentControls.prependContent | contentControls.prependContent | Yes | conditional | No | Yes |
contentControls.insertBefore | contentControls.insertBefore | Yes | conditional | No | Yes |
contentControls.insertAfter | contentControls.insertAfter | Yes | conditional | No | Yes |
contentControls.getBinding | contentControls.getBinding | No | idempotent | No | No |
contentControls.setBinding | contentControls.setBinding | Yes | conditional | No | Yes |
contentControls.clearBinding | contentControls.clearBinding | Yes | conditional | No | Yes |
contentControls.getRawProperties | contentControls.getRawProperties | No | idempotent | No | No |
contentControls.patchRawProperties | contentControls.patchRawProperties | Yes | conditional | No | Yes |
contentControls.validateWordCompatibility | contentControls.validateWordCompatibility | No | idempotent | No | No |
contentControls.normalizeWordCompatibility | contentControls.normalizeWordCompatibility | Yes | idempotent | No | Yes |
contentControls.normalizeTagPayload | contentControls.normalizeTagPayload | Yes | idempotent | No | Yes |
contentControls.text.setMultiline | contentControls.text.setMultiline | Yes | conditional | No | Yes |
contentControls.text.setValue | contentControls.text.setValue | Yes | conditional | No | Yes |
contentControls.text.clearValue | contentControls.text.clearValue | Yes | conditional | No | Yes |
contentControls.date.setValue | contentControls.date.setValue | Yes | conditional | No | Yes |
contentControls.date.clearValue | contentControls.date.clearValue | Yes | conditional | No | Yes |
contentControls.date.setDisplayFormat | contentControls.date.setDisplayFormat | Yes | conditional | No | Yes |
contentControls.date.setDisplayLocale | contentControls.date.setDisplayLocale | Yes | conditional | No | Yes |
contentControls.date.setStorageFormat | contentControls.date.setStorageFormat | Yes | conditional | No | Yes |
contentControls.date.setCalendar | contentControls.date.setCalendar | Yes | conditional | No | Yes |
contentControls.checkbox.getState | contentControls.checkbox.getState | No | idempotent | No | No |
contentControls.checkbox.setState | contentControls.checkbox.setState | Yes | conditional | No | Yes |
contentControls.checkbox.toggle | contentControls.checkbox.toggle | Yes | conditional | No | Yes |
contentControls.checkbox.setSymbolPair | contentControls.checkbox.setSymbolPair | Yes | conditional | No | Yes |
contentControls.choiceList.getItems | contentControls.choiceList.getItems | No | idempotent | No | No |
contentControls.choiceList.setItems | contentControls.choiceList.setItems | Yes | conditional | No | Yes |
contentControls.choiceList.setSelected | contentControls.choiceList.setSelected | Yes | conditional | No | Yes |
contentControls.repeatingSection.listItems | contentControls.repeatingSection.listItems | No | idempotent | No | No |
contentControls.repeatingSection.insertItemBefore | contentControls.repeatingSection.insertItemBefore | Yes | non-idempotent | No | Yes |
contentControls.repeatingSection.insertItemAfter | contentControls.repeatingSection.insertItemAfter | Yes | non-idempotent | No | Yes |
contentControls.repeatingSection.cloneItem | contentControls.repeatingSection.cloneItem | Yes | non-idempotent | No | Yes |
contentControls.repeatingSection.deleteItem | contentControls.repeatingSection.deleteItem | Yes | conditional | No | Yes |
contentControls.repeatingSection.setAllowInsertDelete | contentControls.repeatingSection.setAllowInsertDelete | Yes | conditional | No | Yes |
contentControls.group.wrap | contentControls.group.wrap | Yes | non-idempotent | No | Yes |
contentControls.group.ungroup | contentControls.group.ungroup | Yes | conditional | No | Yes |
Content Controls operations
Content Controls operation reference from the canonical Document API contract.
Back to full reference
Content control (SDT) discovery, mutation, typed controls, and Word compatibility.
Was this page helpful?
⌘I