docx
    Preparing search index...

    Class BuilderElement<T>

    Flexible XML element builder with explicit attribute and child configuration.

    BuilderElement provides a structured way to create XML elements with typed attributes and children. It uses the NextAttributeComponent pattern for explicit attribute key-value mapping.

    // Element with attributes
    new BuilderElement({
      name: "w:spacing",
      attributes: {
        before: { key: "w:before", value: 240 },
        after: { key: "w:after", value: 120 }
      }
    });
    // Generates: <w:spacing w:before="240" w:after="120"/>

    // Element with children
    new BuilderElement({
      name: "w:pPr",
      children: [
        new StringValueElement("w:pStyle", "Heading1")
      ]
    });

    Type Parameters

    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