SetHyperlink Function

Attaches a given hyperlink to the characters given as a continuous range in a given text item from an Envision document currently opened in the Canvas Envision Creator app.

    SetHyperlink(obj: [[[EvItem|canvas-envision-document-items.html#object-items]]], link: [[[EvHyperlink|evhyperlink-interface.html]]], span?: [[[EvCharSpan|evcharspan-interface.html]]]): Promise<void>

Parameters

obj: EvItem

An Object item object, a text item from the Envision document currently opened in the Canvas Envision Creator app with the given range of characters to which the given hyperlink should be attached.

If a given object item is not a text, the function throws an error.

link: EvHyperlink

An EvHyperlink object, a given hyperlink that should be attached to the characters within the given range in the given text item.

span?: EvCharSpan

An EvCharSpan object, a given continuous range of characters to which the given hyperlink should be attached.

The default value is the entire text in the given text item.

Return value

Promise<void>: A Promise that, if fulfilled, resolves to void if the given hyperlink has been successfully attached to the characters within the given range in the given text item in the current document.

Discussion

If a hyperlink is already attached to the given range of characters, the given new hyperlink replaces that attached hyperlink.

17 April 2025