docx
    Preparing search index...

    Class TextWatermark

    Represents a text watermark in a WordprocessingML document.

    TextWatermark is an inline element that belongs inside a paragraph, and the paragraph belongs in a header so that the watermark repeats on every page of the section. It renders as a WordArt shape centred on the page behind the document text, exactly as Word's Design > Watermark command does, so Word recognizes it and can remove or replace it through that command.

    The watermark combines several elements:

    • w:r (run container)
    • w:pict (picture element containing VML)
    • v:shapetype (WordArt shape type definition)
    • v:shape (the positioned WordArt shape)
    • v:fill (opacity)
    • v:textpath (the text and its font)
    new Document({
      sections: [
        {
          headers: {
            default: new Header({
              children: [new Paragraph({ children: [new TextWatermark({ text: "DRAFT" })] })],
            }),
          },
          children: [new Paragraph("Body text")],
        },
      ],
    });

    // Customised watermark
    new TextWatermark({
      text: "CONFIDENTIAL",
      font: "Arial",
      color: "FF0000",
      opacity: 0.3,
      layout: "horizontal",
    });

    Hierarchy (View Summary)

    Index
    constructor
    writtenAs
    addChildElement prepForXml
    • get writtenAs(): readonly BaseXmlComponent[] | undefined
      Internal

      The components written in this one's place, one after another, when it can't be written as a single element, such as a run with another run in its children. Undefined when it is written as itself.

      Returns readonly BaseXmlComponent[] | undefined

    • 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