Class Hyperlink

Hierarchy

XmlComponent
- Hyperlink

Index

Constructors

constructor

Properties

linkId

Accessors

Methods

Constructors

constructor

new Hyperlink(text: string, relationshipId: string, anchor?: undefined | string): Hyperlink

Overrides TableProperties.constructor
- Defined in src/file/paragraph/links/hyperlink.ts:17
Parameters
- text: string
- relationshipId: string
- Optional anchor: undefined | string
Returns Hyperlink

Properties

linkId

linkId: string

Accessors

IsDeleted

get IsDeleted(): boolean

Inherited from AppPropertiesAttributes.IsDeleted
- Defined in src/file/xml-components/base.ts:15
Returns boolean

TextRun

get TextRun(): TextRun

- Defined in src/file/paragraph/links/hyperlink.ts:39
Returns TextRun

Methods

addChildElement

addChildElement(child: XmlComponent | string): XmlComponent

Inherited from AppProperties.addChildElement
- Defined in src/file/xml-components/xml-component.ts:43
Parameters
- child: XmlComponent | string
Returns XmlComponent

delete

delete(): void

Inherited from AppProperties.delete
- Defined in src/file/xml-components/xml-component.ts:49
Returns void

prepForXml

prepForXml(file?: File): IXmlableObject | undefined

Inherited from AppProperties.prepForXml

Overrides BaseXmlComponent.prepForXml
- Defined in src/file/xml-components/xml-component.ts:16
Parameters
- Optional file: File
Returns IXmlableObject | undefined

Generated using TypeDoc