docx
    Preparing search index...

    Class DeletedTextRun

    Represents a deleted text run in a tracked changes document.

    A deletion marks text that has been removed from the document as part of revision tracking. It wraps a text run with metadata about who made the deletion and when. Deleted text is typically shown with strikethrough formatting in applications that support track changes.

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

    <xsd:element name="del" type="CT_RunTrackChange" minOccurs="0"/>

    <xsd:complexType name="CT_RunTrackChange">
      <xsd:complexContent>
        <xsd:extension base="CT_TrackChange">
          <xsd:choice minOccurs="0" maxOccurs="unbounded">
            <xsd:group ref="EG_ContentRunContent"/>
            <xsd:group ref="m:EG_OMathMathElements"/>
          </xsd:choice>
        </xsd:extension>
      </xsd:complexContent>
    </xsd:complexType>

    // Create a deleted text run
    new DeletedTextRun({
      id: 2,
      author: "Jane Smith",
      date: "2024-01-15T11:00:00Z",
      text: "This text was removed",
      italics: true
    });

    // Deleted run with page number field
    new DeletedTextRun({
      id: 3,
      author: "John Doe",
      date: "2024-01-15T12:00:00Z",
      children: [PageNumber.CURRENT]
    });

    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

    XSD Schema
    Constructors
    Methods