docx
    Preparing search index...

    Class CheckBox

    Represents an interactive checkbox in a WordprocessingML document.

    CheckBox creates a content control with checkbox functionality, displaying a checked or unchecked symbol based on its state. The checkbox is implemented using structured document tags (w:sdt) with checkbox-specific properties.

    <xsd:complexType name="CT_SdtCheckbox">
      <xsd:sequence>
        <xsd:element name="checked" type="CT_OnOff" minOccurs="0"/>
        <xsd:element name="checkedState" type="CT_SdtCheckboxSymbol" minOccurs="0"/>
        <xsd:element name="uncheckedState" type="CT_SdtCheckboxSymbol" minOccurs="0"/>
      </xsd:sequence>
    </xsd:complexType>
    <xsd:element name="checkbox" type="CT_SdtCheckbox"/>

    // Simple checkbox
    new CheckBox({ checked: true });

    // Checkbox with custom alias
    new CheckBox({
      checked: false,
      alias: "Accept Terms",
    });

    // Checkbox with custom symbols
    new CheckBox({
      checked: true,
      checkedState: { value: "2611", font: "Wingdings" },
      uncheckedState: { value: "2610", font: "Wingdings" },
    });

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Methods

    addChildElement prepForXml

    Constructors

    Methods

    • Prepares this component and its children for XML serialization.

      This method is called by the Formatter to convert the component tree into an object structure compatible with the xml library (https://www.npmjs.com/package/xml). It recursively processes all children and handles special cases like attribute-only elements and empty elements.

      The method can be overridden by subclasses to customize XML representation or execute side effects during serialization (e.g., creating relationships).

      Parameters

      • context: IContext

        The serialization context containing document state

      Returns IXmlableObject | undefined

      The XML-serializable object, or undefined to exclude from output

      // Override to add custom serialization logic
      prepForXml(context: IContext): IXmlableObject | undefined {
        // Custom logic here
        return super.prepForXml(context);
      }

    Settings

    Member Visibility

    On This Page

    XSD Schema
    Constructors
    Methods