SetPageAction Function

Attaches a given page action to a given object item from an Envision document currently opened in the Canvas Envision Creator app.

    SetPageAction(
        obj: [[[EvItem|canvas-envision-document-items.html#object-items]]],
        action: [[[EvPageAction|evpageaction-interface.html]]],
        tooltip?: string
    ): 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 which the given page action should be attached.
action: EvPageAction: An EvPageAction object, a page action that should be attached to the given object item.
tooltip?: string: A string, an optional custom tooltip that overrides the default tooltip of the given object item.

Return value

Promise<void>: A Promise that, if fulfilled, resolves to void if the given page action has been successfully attached to the given object item in the current Envision document.

27 March 2025