SetHyperlink Function

Attaches a new hyperlink to a given object item or replaces a hyperlink already attached to a given object 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]]]): Promise<void>

Parameters

obj: EvItem: An Object item object, an object item from the Envision document currently opened in the Canvas Envision Creator app to whom the given hyperlink should be attached or whose attached hyperlink should be replaced with the given hyperlink.
link: EvHyperlink: An EvHyperlink object, a new hyperlink that should be attached to the given object item.

Return value

Promise<void>: A Promise that, if fulfilled, resolves to void if the given hyperlink has been successfully attached to the given object item.

Discussion

To go to the target of a hyperlink attached to an object item:

Click the object item in the Canvas Envision Viewer.
While pressing the Ctrl key, click the object item in the Canvas Envision Creator.

27 March 2025