set_unchecked_symbol method

set_unchecked_symbol(character_code, font_name)

Sets the symbol used to represent the unchecked state of a check box content control.

def set_unchecked_symbol(self, character_code: int, font_name: str):
    ...
ParameterTypeDescription
character_codeintThe character code for the specified symbol.
font_namestrThe name of the font that contains the symbol.

Remarks

Accessing this method 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.

doc = aw.Document()
builder = aw.DocumentBuilder(doc)

sdt_check_box = aw.markup.StructuredDocumentTag(doc, aw.markup.SdtType.CHECKBOX, aw.markup.MarkupLevel.INLINE)
sdt_check_box.checked = True

# We can set the symbols used to represent the checked/unchecked state of a checkbox content control.
sdt_check_box.set_checked_symbol(0x00A9, "Times New Roman")
sdt_check_box.set_unchecked_symbol(0x00AE, "Times New Roman")

builder.insert_node(sdt_check_box)

doc.save(ARTIFACTS_DIR + "StructuredDocumentTag.check_box.docx")

See Also

StructuredDocumentTag.set_checked_symbol method