evCreate API 5.7 Help

AddPage Function

Explicitly adds a new page to an Envision document currently opened in the Canvas Envision Creator app during an active Vertical Layout session.

AddPage(name?: string, title?: string): Promise<[[[EvItem|canvas-envision-document-items.html#page-items]]]>

Parameters

name?: string

A string, the name of the new page.

If it is not given, the system generates the page name.

title?: string

A string, the title that should be displayed at the top of the new page.

If it is given, the header and footer from the Vertical Layout session configuration are ignored for this page.

The default value is no title.

Return value

Promise<EvItem>

A Promise that, if fulfilled, resolves to a Page item object of the new page successfully added to the current document during an active Vertical Layout session.

Discussion

The function will throw an error if Vertical Layout mode has not been activated.

Once a new page is added explicitly, new object items will be added from the top of this new page, even when the previous page has enough space left to accommodate new objects.

23 April 2025