Class ConcreteHyperlink

Represents a hyperlink in a WordprocessingML document.

The hyperlink element specifies a hyperlink that can be either internal (to a bookmark) or external (to a URL).

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

Hierarchy (View Summary)

XmlComponent
- ConcreteHyperlink
  - InternalHyperlink

Index

Constructors

Properties

Methods

addChildElement prepForXml

Constructors

constructor

new ConcreteHyperlink(
    children: readonly ParagraphChild[],
    relationshipId: string,
    anchor?: string,
): ConcreteHyperlink
Parameters
- children: readonly ParagraphChild[]
- relationshipId: string
- Optionalanchor: string
Returns ConcreteHyperlink
Overrides XmlComponent.constructor
- Defined in file/paragraph/links/hyperlink.ts:37

Properties

`Readonly`linkId

linkId: string

Methods

addChildElement

addChildElement(child: string | XmlComponent): XmlComponent
Parameters
- child: string | XmlComponent
Returns XmlComponent
Deprecated
Do not use this method. It is only used internally by the library. It will be removed in a future version.
Inherited from XmlComponent.addChildElement
- Defined in file/xml-components/xml-component.ts:67

prepForXml

prepForXml(context: IContext): undefined | IXmlableObject
Parameters
- context: IContext
Returns undefined | IXmlableObject
Inherited from XmlComponent.prepForXml
- Defined in file/xml-components/xml-component.ts:39