Word.ContentControlState enum

Remarks

API set: WordApi BETA (PREVIEW ONLY)

Used by

• Word.ContentControl: setState

Examples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/99-preview-apis/insert-and-change-content-controls.yaml

// Sets the state of the first content control.
await Word.run(async (context) => {
 const state = ((document.getElementById("state-to-set") as HTMLSelectElement)
 .value as unknown) as Word.ContentControlState;
 let firstContentControl = context.document.contentControls.getFirstOrNullObject();
 await context.sync();

 if (firstContentControl.isNullObject) {
 console.warn("There are no content controls in this document.");
 return;
 }

 firstContentControl.setState(state);
 firstContentControl.load("id");
 await context.sync();

 console.log(`Set state of first content control with ID ${firstContentControl.id} to ${state}.`);
});

Fields