Class InternalHyperlink

Represents an internal hyperlink to a bookmark within the document.

Example

new InternalHyperlink({
  children: [new TextRun("Go to Section 1")],
  anchor: "section1",
});

Hierarchy (View Summary)

ConcreteHyperlink
- InternalHyperlink

Index

Constructors

constructor

new InternalHyperlink(
options: { anchor: string; children: readonly ParagraphChild[] },
): InternalHyperlink
Parameters
- options: { anchor: string; children: readonly ParagraphChild[] }
Returns InternalHyperlink
Overrides ConcreteHyperlink.constructor
- Defined in file/paragraph/links/hyperlink.ts:68

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 ConcreteHyperlink.addChildElement
- Defined in file/xml-components/xml-component.ts:67

prepForXml

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

Class InternalHyperlink

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns InternalHyperlink

Properties

`Readonly`linkId

Methods

addChildElement

Parameters

Returns XmlComponent

Deprecated

prepForXml

Parameters

Returns undefined | IXmlableObject

Settings

On This Page

Class InternalHyperlink

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns InternalHyperlink

Properties

ReadonlylinkId

Methods

addChildElement

Parameters

Returns XmlComponent

Deprecated

prepForXml

Parameters

Returns undefined | IXmlableObject

Settings

On This Page

`Readonly`linkId