docx
    Preparing search index...

    Class SequentialIdentifier

    Represents a sequential identifier field in a WordprocessingML document.

    SequentialIdentifier creates a SEQ field that automatically numbers items in a document. Each identifier maintains its own sequence, allowing you to have separate numbering for figures, tables, equations, etc.

    It is written dirty, so Word numbers it when it opens the document, after asking to update the fields. When the document is given pageNumbers, it is written clean, with its number counted as Word counts it, or blank where Word's count isn't known, and Word doesn't ask.

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

    <xsd:complexType name="CT_R">
      <xsd:sequence>
        <xsd:group ref="EG_RunInnerContent" minOccurs="0" maxOccurs="unbounded"/>
      </xsd:sequence>
    </xsd:complexType>

    // Create a figure number
    new SequentialIdentifier("Figure");

    // Create a table number
    new SequentialIdentifier("Table");

    // Create an equation number
    new SequentialIdentifier("Equation");

    Hierarchy (View Summary)

    • Run
      • SequentialIdentifier
    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