checked property

StructuredDocumentTag.checked property

Gets/Sets current state of the Checkbox SDT. Default value for this property is false.

get checked(): boolean

Remarks

Accessing this property will only work for SdtType.Checkbox SDT types.

For all other SDT types exception will occur.

Examples

Show how to create a structured document tag in the form of a check box.

let doc = new aw.Document();
let builder = new aw.DocumentBuilder(doc);

let sdtCheckBox = new aw.Markup.StructuredDocumentTag(doc, aw.Markup.SdtType.Checkbox, aw.Markup.MarkupLevel.Inline);
sdtCheckBox.checked = true;

// We can set the symbols used to represent the checked/unchecked state of a checkbox content control.
sdtCheckBox.setCheckedSymbol(0x00A9, "Times New Roman");
sdtCheckBox.setUncheckedSymbol(0x00AE, "Times New Roman");

builder.insertNode(sdtCheckBox);

doc.save(base.artifactsDir + "StructuredDocumentTag.checkBox.docx");

See Also

StructuredDocumentTag.calendarType property StructuredDocumentTag.color property