docx
    Preparing search index...

    Class ConcreteHyperlink

    Represents a concrete hyperlink in a WordprocessingML document.

    This class is the low-level implementation of hyperlinks used internally. Use InternalHyperlink or ExternalHyperlink for creating hyperlinks in documents.

    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 name="tgtFrame" type="s:ST_String" use="optional"/>
      <xsd:attribute name="tooltip" type="s:ST_String" use="optional"/>
      <xsd:attribute name="docLocation" type="s:ST_String" use="optional"/>
      <xsd:attribute name="history" type="s:ST_OnOff" use="optional"/>
      <xsd:attribute name="anchor" type="s:ST_String" use="optional"/>
      <xsd:attribute ref="r:id"/>
    </xsd:complexType>

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    linkId

    Methods

    addChildElement prepForXml

    Constructors

    Properties

    linkId: string

    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
    Properties
    Methods