Hyperlink class Worksheet

A hyperlink attached to a cell (or cell range).

Two kinds are supported:

  • External: a web/mailto:/file URL (Hyperlink.url, Hyperlink.email). Stored as a worksheet relationship with TargetMode="External".
  • Internal: a jump within the same workbook such as 'Sheet2'!B3 or a defined name (Hyperlink.location). Stored inline, with no relationship.

Constructors

Hyperlink.email(String address, {String? subject, String? display, String? tooltip})
A mailto: link to address, with an optional subject.
factory
Hyperlink.location(String location, {String? display, String? tooltip})
An internal link to location within the workbook, e.g. 'Sheet2'!A1 or a defined name.
factory
Hyperlink.url(String url, {String? display, String? tooltip})
A link to an external url (web, mailto:, file, ...).
factory

Properties

display → String?
Optional text shown for the link.
final
hashCode → int
The hash code for this object.
no setteroverride
isExternal → bool
Whether this is an external (URL) link rather than an internal jump.
no setter
location → String?
Internal location within the workbook (e.g. 'Sheet2'!A1 or a defined name), or null for an external link.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
target → String?
External target URL (e.g. https://..., mailto:...), or null for an internal link.
final
tooltip → String?
Optional hover tooltip.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
override

Operators

operator ==(Object other) → bool
The equality operator.
override