docx
    Preparing search index...

    Class Citation

    A citation of one or more of the document's sources, by their tags, such as "(Baker, 2010)" in APA, as Word's References > Insert Citation inserts it. It is written in the style of the document's bibliography, and Word writes it again when it updates the document's fields, or when the style is changed.

    The document needs its sources: give it bibliography: createBibliography({ sources }).

    new Paragraph({ children: [new TextRun("Pizza is older than you think "), new Citation("Bak10")] });

    // Pages, and text before the citation
    new Citation({ source: "Bak10", pages: "50", prefix: "see " });

    // Two sources, as one citation: "(Baker, 2010; Evans, 2019, p. 20)"
    new Citation(["Bak10", { source: "Eva19", pages: "20" }]);

    Hierarchy (View Summary)

    Index
    constructor
    writtenAs
    addChildElement prepForXml

    • 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
    Accessors
    Methods