docx
    Preparing search index...

    Class ExternalHyperlink

    Represents an external hyperlink to a URL outside the document.

    External hyperlinks create a relationship to an external resource (URL). The relationship is created during document preparation and the hyperlink is converted to a ConcreteHyperlink with the relationship ID.

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

    <xsd:element name="hyperlink" type="CT_Hyperlink"/>

    <xsd:complexType name="CT_Hyperlink">
      <xsd:group ref="EG_PContent" minOccurs="0" maxOccurs="unbounded"/>
      <xsd:attribute ref="r:id"/>
      <xsd:attribute name="history" type="s:ST_OnOff" use="optional"/>
    </xsd:complexType>

    new ExternalHyperlink({
      children: [new TextRun({ text: "Visit Example", style: "Hyperlink" })],
      link: "https://example.com",
    });

    Hierarchy (View Summary)

    Index
    constructor
    options
    writtenAs
    addChildElement prepForXml
    options: IExternalHyperlinkOptions
    • 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
    Properties
    Accessors
    Methods