docx
    Preparing search index...

    Class XmlComponentAbstract

    Base class for all XML components in WordprocessingML documents.

    XmlComponent provides the infrastructure for building XML element trees that are serialized into document.xml and other parts of the DOCX package. It manages a collection of child components and handles the conversion to the intermediate object format used by the xml serialization library.

    // Creating a custom XML component
    class MyElement extends XmlComponent {
      constructor(text: string) {
        super("w:myElement");
        this.root.push(new Attributes({ val: text }));
      }
    }

    const element = new MyElement("Hello");
    // When serialized: <w:myElement w:val="Hello"/>

    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