Class BuilderElement<T>

Base class for all XML components in WordprocessingML documents.

XmlComponent provides the infrastructure for building XML trees that are serialized into the document.xml and other parts of the DOCX package.

Type Parameters

T extends AttributeData = {}

Hierarchy (View Summary)

XmlComponent
- BuilderElement
  - MathPreSubSuperScript

Index

Constructors

Methods

addChildElement prepForXml

Constructors

constructor

new BuilderElement<T extends AttributeData = {}>(
    __namedParameters: {
        attributes?: AttributePayload<T>;
        children?: readonly XmlComponent[];
        name: string;
    },
): BuilderElement<T>
Type Parameters
- T extends AttributeData = {}
Parameters
- __namedParameters: {
      attributes?: AttributePayload<T>;
      children?: readonly XmlComponent[];
      name: string;
  }
Returns BuilderElement<T>
Overrides XmlComponent.constructor
- Defined in file/xml-components/simple-elements.ts:93

Methods

addChildElement

addChildElement(child: string | XmlComponent): XmlComponent
Parameters
- child: string | XmlComponent
Returns XmlComponent
Deprecated
Do not use this method. It is only used internally by the library. It will be removed in a future version.
Inherited from XmlComponent.addChildElement
- Defined in file/xml-components/xml-component.ts:67

prepForXml

prepForXml(context: IContext): undefined | IXmlableObject
Parameters
- context: IContext
Returns undefined | IXmlableObject
Inherited from XmlComponent.prepForXml
- Defined in file/xml-components/xml-component.ts:39