SetMasterPage Function

Links a given regular document page with a given master page or unlinks a given regular document page with the linked master page in an Envision document currently opened in the Canvas Envision Creator app.

    SetMasterPage(page: [[[EvItem|canvas-envision-document-items.html#page-items]]], masterPage?: [[[EvItem|canvas-envision-document-items.html#page-items]]]): Promise<void>

Parameters

page: EvItem

A Page item object of a regular document page in the Envision document currently opened in the Canvas Envision Creator app that should be either:

Linked with the given master page.
Unlinked with the already linked master page.

masterPage?: EvItem

A Page item object of a master page in the Envision document currently opened in the Canvas Envision Creator app that should be linked with the given regular document page.

If it is not given or set to null, the given regular document page is unlinked with the already linked master page.

Return value

Promise<void>: A Promise that, if fulfilled, resolves to void if the given regular document page has been successfully linked or unlinked with the master page in the current Envision document.

13 March 2025