Represents a hyperlink for a cell or region.

Constructors

Section titled "Constructors"

WorksheetHyperlink 

new WorksheetHyperlink(sourceAddress: string, target: any, displayText: string, toolTip: string): WorksheetHyperlink

Returns WorksheetHyperlink

Properties

Section titled "Properties"

$t

Section titled "$t" 
$t: Type

Accessors

Section titled "Accessors"

displayText

Section titled "displayText"

Gets or sets the text to display in the cell when the hyperlink is added to a worksheet, or null to use the target text.

 
get displayText(): string

Returns string 

set displayText(a: string): void

Parameters

  • a: string

Returns void

isSealed

Section titled "isSealed"

Gets the value indicating whether the hyperlink is sealed and cannot be modified.

 
get isSealed(): boolean

Returns boolean

sourceAddress

Section titled "sourceAddress"

Gets or sets the address of the cell or region on which the hyperlink resides.

 
get sourceAddress(): string

Returns string 

set sourceAddress(a: string): void

Parameters

  • a: string

Returns void

sourceCell

Section titled "sourceCell"

Gets or sets the cell on which the hyperlink resides.

 
get sourceCell(): WorksheetCell

Returns WorksheetCell 

set sourceCell(a: WorksheetCell): void

Parameters

Returns void

sourceRegion

Section titled "sourceRegion"

Gets or sets the region on which the hyperlink resides.

 
get sourceRegion(): WorksheetRegion

Returns WorksheetRegion 

set sourceRegion(a: WorksheetRegion): void

Parameters

Returns void

target

Section titled "target"

Gets or sets the target of the hyperlink, which can be a string, [[WorksheetCell]], [[WorksheetRegion]], or [[NamedReference]] instance. For bookmarks in an external document, separate the sub-address with a #, such as "File.xlsx#Sheet1!C3". For email addresses, use a target string with the format "mailto:joe@company.com" or "mailto:joe@company.com?subject=Email%20Subject".

 
get target(): any

Returns any 

set target(a: any): void

Parameters

  • a: any

Returns void

targetAddress

Section titled "targetAddress"

Gets or sets the target address of the hyperlink. For bookmarks in an external document, separate the sub-address with a #, such as "File.xlsx#Sheet1!C3". For email addresses, use a target string with the format "mailto:joe@company.com" or "mailto:joe@company.com?subject=Email%20Subject".

 
get targetAddress(): string

Returns string 

set targetAddress(a: string): void

Parameters

  • a: string

Returns void

targetCell

Section titled "targetCell"

Gets or sets the target cell of the hyperlink.

 
get targetCell(): WorksheetCell

Returns WorksheetCell 

set targetCell(a: WorksheetCell): void

Parameters

Returns void

targetNamedReference

Section titled "targetNamedReference"

Gets or sets the target named reference of the hyperlink.

 
get targetNamedReference(): NamedReference

Returns NamedReference 

set targetNamedReference(a: NamedReference): void

Parameters

Returns void

targetRegion

Section titled "targetRegion"

Gets or sets the target region of the hyperlink.

 
get targetRegion(): WorksheetRegion

Returns WorksheetRegion 

set targetRegion(a: WorksheetRegion): void

Parameters

Returns void

toolTip

Section titled "toolTip"

Gets or sets the text to use in a tool tip when hovering over the source cell or region, or null to use the default tool tip.

 
get toolTip(): string

Returns string 

set toolTip(a: string): void

Parameters

  • a: string

Returns void

worksheet

Section titled "worksheet"

Gets the worksheet to which the hyperlink belongs.

 
get worksheet(): Worksheet

Returns Worksheet

Methods

Section titled "Methods"

toString

Section titled "toString"

Gets the string representation of the hyperlink.

 
toString(): string

Returns string