docx
    Preparing search index...

    Class OnOffElement

    XML element representing a boolean on/off value (CT_OnOff).

    This element type is used throughout WordprocessingML to represent boolean properties. A value of true (or 1) means the property is enabled. A value of false (or 0) means it is explicitly disabled. When the value is true, the attribute is often omitted.

    OOXML Reference:

    <xsd:complexType name="CT_OnOff">
      <xsd:attribute name="val" type="s:ST_OnOff"/>
    </xsd:complexType>

    // Bold enabled (w:val omitted when true)
    new OnOffElement("w:b", true);
    // Generates: <w:b/>

    // Bold explicitly disabled
    new OnOffElement("w:b", false);
    // Generates: <w:b w:val="false"/>

    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

    Constructors
    Methods