BeforeHyperlinkArgs

23 Sep 20251 minute to read

Specifies arguments before a hyperlink is created or clicked.

Properties

address string

Specifies the range of cells where the hyperlink should be added.

cancel boolean

Specifies whether the action of opening the hyperlink should be canceled.
If set to true, the action will be stopped.

displayText string

Specifies the text to be displayed for the hyperlink.
If no text is provided, the current value of the cell is displayed by default.

Specifies the hyperlink reference.
This can either be a URL string (e.g., “https://example.com”) or a HyperlinkModel object for more advanced configurations.

target string

Specifies the target window or frame where the hyperlink will open.
Common values:

  • _blank: Opens in a new tab or window.
  • _self: Opens in the same tab or window.
  • _parent: Opens in the parent frame.
  • _top: Opens in the topmost frame.
  • Custom frame name.