docx
    Preparing search index...

    Class Comments

    Represents the comments container in a WordprocessingML document.

    This is the root element for the comments.xml file that stores all comment definitions in the document.

    Reference: http://officeopenxml.com/WPrun.php

    <xsd:element name="comments" type="CT_Comments"/>
    <xsd:complexType name="CT_Comments">
      <xsd:sequence>
        <xsd:element name="comment" type="CT_Comment" minOccurs="0" maxOccurs="unbounded"/>
      </xsd:sequence>
    </xsd:complexType>

    new Comments({
      children: [
        {
          id: 0,
          author: "John Doe",
          children: [new Paragraph("First comment")],
        },
        {
          id: 1,
          author: "Jane Smith",
          children: [new Paragraph("Second comment")],
        },
      ],
    });

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Accessors

    Relationships

    Methods

    addChildElement prepForXml

    Constructors

    Accessors

    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
    Accessors
    Methods